com.squareup.square.models

Class Card

java.lang.Object

com.squareup.square.models.Card

public class Card
extends Object

This is a model class for Card type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Card.Builder Class to build instances of Card.

Constructor Summary

Constructors

Modifier	Constructor and Description
	Card(String id, String cardBrand, String last4, Long expMonth, Long expYear, String cardholderName, Address billingAddress, String fingerprint, String customerId, String merchantId, String referenceId, Boolean enabled, String cardType, String prepaidType, String bin, Long version, String cardCoBrand) Initialization constructor.
protected	Card(String id, String cardBrand, String last4, io.apimatic.core.types.OptionalNullable<Long> expMonth, io.apimatic.core.types.OptionalNullable<Long> expYear, io.apimatic.core.types.OptionalNullable<String> cardholderName, Address billingAddress, String fingerprint, io.apimatic.core.types.OptionalNullable<String> customerId, String merchantId, io.apimatic.core.types.OptionalNullable<String> referenceId, Boolean enabled, String cardType, String prepaidType, String bin, Long version, String cardCoBrand) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Address	getBillingAddress() Getter for BillingAddress.
String	getBin() Getter for Bin.
String	getCardBrand() Getter for CardBrand.
String	getCardCoBrand() Getter for CardCoBrand.
String	getCardholderName() Getter for CardholderName.
String	getCardType() Getter for CardType.
String	getCustomerId() Getter for CustomerId.
Boolean	getEnabled() Getter for Enabled.
Long	getExpMonth() Getter for ExpMonth.
Long	getExpYear() Getter for ExpYear.
String	getFingerprint() Getter for Fingerprint.
String	getId() Getter for Id.
String	getLast4() Getter for Last4.
String	getMerchantId() Getter for MerchantId.
String	getPrepaidType() Getter for PrepaidType.
String	getReferenceId() Getter for ReferenceId.
Long	getVersion() Getter for Version.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCardholderName() Internal Getter for CardholderName.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCustomerId() Internal Getter for CustomerId.
protected io.apimatic.core.types.OptionalNullable<Long>	internalGetExpMonth() Internal Getter for ExpMonth.
protected io.apimatic.core.types.OptionalNullable<Long>	internalGetExpYear() Internal Getter for ExpYear.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetReferenceId() Internal Getter for ReferenceId.
Card.Builder	toBuilder() Builds a new Card.Builder object.
String	toString() Converts this Card into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Card

public Card(String id,
            String cardBrand,
            String last4,
            Long expMonth,
            Long expYear,
            String cardholderName,
            Address billingAddress,
            String fingerprint,
            String customerId,
            String merchantId,
            String referenceId,
            Boolean enabled,
            String cardType,
            String prepaidType,
            String bin,
            Long version,
            String cardCoBrand)

Initialization constructor.

Parameters:

id - String value for id.

cardBrand - String value for cardBrand.

last4 - String value for last4.

expMonth - Long value for expMonth.

expYear - Long value for expYear.

cardholderName - String value for cardholderName.

billingAddress - Address value for billingAddress.

fingerprint - String value for fingerprint.

customerId - String value for customerId.

merchantId - String value for merchantId.

referenceId - String value for referenceId.

enabled - Boolean value for enabled.

cardType - String value for cardType.

prepaidType - String value for prepaidType.

bin - String value for bin.

version - Long value for version.

cardCoBrand - String value for cardCoBrand.

Card

protected Card(String id,
               String cardBrand,
               String last4,
               io.apimatic.core.types.OptionalNullable<Long> expMonth,
               io.apimatic.core.types.OptionalNullable<Long> expYear,
               io.apimatic.core.types.OptionalNullable<String> cardholderName,
               Address billingAddress,
               String fingerprint,
               io.apimatic.core.types.OptionalNullable<String> customerId,
               String merchantId,
               io.apimatic.core.types.OptionalNullable<String> referenceId,
               Boolean enabled,
               String cardType,
               String prepaidType,
               String bin,
               Long version,
               String cardCoBrand)

Initialization constructor.

Parameters:

id - String value for id.

cardBrand - String value for cardBrand.

last4 - String value for last4.

expMonth - Long value for expMonth.

expYear - Long value for expYear.

cardholderName - String value for cardholderName.

billingAddress - Address value for billingAddress.

fingerprint - String value for fingerprint.

customerId - String value for customerId.

merchantId - String value for merchantId.

referenceId - String value for referenceId.

enabled - Boolean value for enabled.

cardType - String value for cardType.

prepaidType - String value for prepaidType.

bin - String value for bin.

version - Long value for version.

cardCoBrand - String value for cardCoBrand.

Method Detail

getId

public String getId()

Getter for Id. Unique ID for this card. Generated by Square.

Returns:

Returns the String

getCardBrand

public String getCardBrand()

Getter for CardBrand. Indicates a card's brand, such as `VISA` or `MASTERCARD`.

Returns:

Returns the String

getLast4

public String getLast4()

Getter for Last4. The last 4 digits of the card number.

Returns:

Returns the String

internalGetExpMonth

protected io.apimatic.core.types.OptionalNullable<Long> internalGetExpMonth()

Internal Getter for ExpMonth. The expiration month of the associated card as an integer between 1 and 12.

Returns:

Returns the Internal Long

getExpMonth

public Long getExpMonth()

Getter for ExpMonth. The expiration month of the associated card as an integer between 1 and 12.

Returns:

Returns the Long

internalGetExpYear

protected io.apimatic.core.types.OptionalNullable<Long> internalGetExpYear()

Internal Getter for ExpYear. The four-digit year of the card's expiration date.

Returns:

Returns the Internal Long

getExpYear

public Long getExpYear()

Getter for ExpYear. The four-digit year of the card's expiration date.

Returns:

Returns the Long

internalGetCardholderName

protected io.apimatic.core.types.OptionalNullable<String> internalGetCardholderName()

Internal Getter for CardholderName. The name of the cardholder.

Returns:

Returns the Internal String

getCardholderName

public String getCardholderName()

Getter for CardholderName. The name of the cardholder.

Returns:

Returns the String

getBillingAddress

public Address getBillingAddress()

Getter for BillingAddress. Represents a postal address in a country. For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).

Returns:

Returns the Address

getFingerprint

public String getFingerprint()

Getter for Fingerprint. Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.

Returns:

Returns the String

internalGetCustomerId

protected io.apimatic.core.types.OptionalNullable<String> internalGetCustomerId()

Internal Getter for CustomerId. **Required** The ID of a customer created using the Customers API to be associated with the card.

Returns:

Returns the Internal String

getCustomerId

public String getCustomerId()

Getter for CustomerId. **Required** The ID of a customer created using the Customers API to be associated with the card.

Returns:

Returns the String

getMerchantId

public String getMerchantId()

Getter for MerchantId. The ID of the merchant associated with the card.

Returns:

Returns the String

internalGetReferenceId

protected io.apimatic.core.types.OptionalNullable<String> internalGetReferenceId()

Internal Getter for ReferenceId. An optional user-defined reference ID that associates this card with another entity in an external system. For example, a customer ID from an external customer management system.

Returns:

Returns the Internal String

getReferenceId

public String getReferenceId()

Getter for ReferenceId. An optional user-defined reference ID that associates this card with another entity in an external system. For example, a customer ID from an external customer management system.

Returns:

Returns the String

getEnabled

public Boolean getEnabled()

Getter for Enabled. Indicates whether or not a card can be used for payments.

Returns:

Returns the Boolean

getCardType

public String getCardType()

Getter for CardType. Indicates a card's type, such as `CREDIT` or `DEBIT`.

Returns:

Returns the String

getPrepaidType

public String getPrepaidType()

Getter for PrepaidType. Indicates a card's prepaid type, such as `NOT_PREPAID` or `PREPAID`.

Returns:

Returns the String

getBin

public String getBin()

Getter for Bin. The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API returns this field.

Returns:

Returns the String

getVersion

public Long getVersion()

Getter for Version. Current version number of the card. Increments with each card update. Requests to update an existing Card object will be rejected unless the version in the request matches the current version for the Card.

Returns:

Returns the Long

getCardCoBrand

public String getCardCoBrand()

Getter for CardCoBrand. Indicates the brand for a co-branded card.

Returns:

Returns the String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this Card into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public Card.Builder toBuilder()

Builds a new Card.Builder object. Creates the instance with the state of the current model.

Returns:

a new Card.Builder object