Class Card

    • Constructor Detail

      • Card

        public Card()
        Constructs a new empty instance.
      • Card

        protected Card​(boolean noInit)
        Constructs a new empty instance.
      • Card

        public Card​(JSONObject jsonObject)
        Construct a new instance backed by the given JSONObject, the parameter is not copied so changes to it will be reflected in this instance and vice-versa.
      • Card

        public Card​(Card src)
        Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
    • Method Detail

      • getId

        public String getId()
        Unique identifier for the object.
      • getNumber

        public String getNumber()
        card number
      • getEncryptedPan

        public String getEncryptedPan()
        Encrypted Card provided by TA. This is encrypted with Transarmor RSA key and is sent for processing
      • getEncryptedTrack2

        public String getEncryptedTrack2()
        Encrypted Track 2 Data provided by Clover devices from EMV or Swipe. This is encrypted with Transarmor RSA key
      • getEncryptedPanForBinLookup

        public String getEncryptedPanForBinLookup()
        Encrypted Card for bin lookup purposes only. This is encrypted with custom RSA key used by Bin lookup service, which can determine whether it is purchase card or not
      • getTransarmorToken

        public String getTransarmorToken()
        Transarmor token (needed for Payeezy migration)
      • getTransarmorTokenType

        public String getTransarmorTokenType()
        Transarmor token type (needed for Payeezy migration)
      • getTokenMetaId

        public Long getTokenMetaId()
        token meta id in the db
      • getTransarmorKeyId

        public String getTransarmorKeyId()
        Transarmor key id to be used to encrypt pan or track data during tokenization request. If not specified, then default Transarmor key id will be used
      • getExpMonth

        public String getExpMonth()
        Two-digit number representing the card's expiration month.
      • getExpYear

        public String getExpYear()
        Two- or four-digit number representing the card's expiration year.
      • getCvv

        public String getCvv()
        card verification value
      • getFirst6

        public String getFirst6()
        first6 of number
      • getLast4

        public String getLast4()
        last4 of number (for response only)
      • getCountry

        public String getCountry()
        two character country code
      • getBrand

        public CardType getBrand()
        brand of card (for response only)
      • getIsPurchaseCard

        public Boolean getIsPurchaseCard()
        whether this is purchase card or not
      • getCreatedTime

        public Long getCreatedTime()
      • getModifiedTime

        public Long getModifiedTime()
      • getObject

        public String getObject()
        String representing the object’s type. Objects of the same type share the same value.
      • getCvc

        public String getCvc()
        Card security code. Highly recommended to always include this value.
      • getCurrency

        public String getCurrency()
        Required in order to add the card to an account; in all other cases, this parameter is not used. When added to an account, the card (which must be a debit card) can be used as a transfer destination for funds in this currency. Currently, the only supported currency for debit card payouts is `usd`.
      • getName

        public String getName()
        Cardholder's full name.
      • getAddressLine1

        public String getAddressLine1()
        Address line 1 (Street address / PO Box / Company name).
      • getAddressLine1Check

        public String getAddressLine1Check()
        If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked.
      • getAddressLine2

        public String getAddressLine2()
        Address line 2 (Apartment / Suite / Unit / Building).
      • getAddressCity

        public String getAddressCity()
        City / District / Suburb / Town / Village.
      • getAddressState

        public String getAddressState()
        State / County / Province / Region.
      • getAddressZip

        public String getAddressZip()
        ZIP or postal code.
      • getAddressZipCheck

        public String getAddressZipCheck()
        If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked.
      • getAddressCountry

        public String getAddressCountry()
        Billing address country, if provided.
      • getCvcCheck

        public String getCvcCheck()
        If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked.
      • getFingerprint

        public String getFingerprint()
        Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example.
      • getJSONObject

        public JSONObject getJSONObject()
        Returns the internal JSONObject backing this instance, the return value is not a copy so changes to it will be reflected in this instance and vice-versa.
        Specified by:
        getJSONObject in interface JSONifiable
      • isNotNullId

        public boolean isNotNullId()
        Checks whether the 'id' field is set and is not null
      • isNotNullNumber

        public boolean isNotNullNumber()
        Checks whether the 'number' field is set and is not null
      • isNotNullEncryptedPan

        public boolean isNotNullEncryptedPan()
        Checks whether the 'encrypted_pan' field is set and is not null
      • isNotNullEncryptedTrack2

        public boolean isNotNullEncryptedTrack2()
        Checks whether the 'encrypted_track2' field is set and is not null
      • isNotNullEncryptedPanForBinLookup

        public boolean isNotNullEncryptedPanForBinLookup()
        Checks whether the 'encrypted_pan_for_bin_lookup' field is set and is not null
      • isNotNullTransarmorToken

        public boolean isNotNullTransarmorToken()
        Checks whether the 'transarmor_token' field is set and is not null
      • isNotNullTransarmorTokenType

        public boolean isNotNullTransarmorTokenType()
        Checks whether the 'transarmor_token_type' field is set and is not null
      • isNotNullTokenMetaId

        public boolean isNotNullTokenMetaId()
        Checks whether the 'token_meta_id' field is set and is not null
      • isNotNullTransarmorKeyId

        public boolean isNotNullTransarmorKeyId()
        Checks whether the 'transarmor_key_id' field is set and is not null
      • isNotNullExpMonth

        public boolean isNotNullExpMonth()
        Checks whether the 'exp_month' field is set and is not null
      • isNotNullExpYear

        public boolean isNotNullExpYear()
        Checks whether the 'exp_year' field is set and is not null
      • isNotNullCvv

        public boolean isNotNullCvv()
        Checks whether the 'cvv' field is set and is not null
      • isNotNullFirst6

        public boolean isNotNullFirst6()
        Checks whether the 'first6' field is set and is not null
      • isNotNullLast4

        public boolean isNotNullLast4()
        Checks whether the 'last4' field is set and is not null
      • isNotNullCountry

        public boolean isNotNullCountry()
        Checks whether the 'country' field is set and is not null
      • isNotNullBrand

        public boolean isNotNullBrand()
        Checks whether the 'brand' field is set and is not null
      • isNotNullFundingType

        public boolean isNotNullFundingType()
        Checks whether the 'funding_type' field is set and is not null
      • isNotNullIsPurchaseCard

        public boolean isNotNullIsPurchaseCard()
        Checks whether the 'is_purchase_card' field is set and is not null
      • isNotNullCreatedTime

        public boolean isNotNullCreatedTime()
        Checks whether the 'created_time' field is set and is not null
      • isNotNullModifiedTime

        public boolean isNotNullModifiedTime()
        Checks whether the 'modified_time' field is set and is not null
      • isNotNullObject

        public boolean isNotNullObject()
        Checks whether the 'object' field is set and is not null
      • isNotNullCvc

        public boolean isNotNullCvc()
        Checks whether the 'cvc' field is set and is not null
      • isNotNullCurrency

        public boolean isNotNullCurrency()
        Checks whether the 'currency' field is set and is not null
      • isNotNullName

        public boolean isNotNullName()
        Checks whether the 'name' field is set and is not null
      • isNotNullAddressLine1

        public boolean isNotNullAddressLine1()
        Checks whether the 'address_line1' field is set and is not null
      • isNotNullAddressLine1Check

        public boolean isNotNullAddressLine1Check()
        Checks whether the 'address_line1_check' field is set and is not null
      • isNotNullAddressLine2

        public boolean isNotNullAddressLine2()
        Checks whether the 'address_line2' field is set and is not null
      • isNotNullAddressCity

        public boolean isNotNullAddressCity()
        Checks whether the 'address_city' field is set and is not null
      • isNotNullAddressState

        public boolean isNotNullAddressState()
        Checks whether the 'address_state' field is set and is not null
      • isNotNullAddressZip

        public boolean isNotNullAddressZip()
        Checks whether the 'address_zip' field is set and is not null
      • isNotNullAddressZipCheck

        public boolean isNotNullAddressZipCheck()
        Checks whether the 'address_zip_check' field is set and is not null
      • isNotNullAddressCountry

        public boolean isNotNullAddressCountry()
        Checks whether the 'address_country' field is set and is not null
      • isNotNullCvcCheck

        public boolean isNotNullCvcCheck()
        Checks whether the 'cvc_check' field is set and is not null
      • isNotNullFingerprint

        public boolean isNotNullFingerprint()
        Checks whether the 'fingerprint' field is set and is not null
      • hasId

        public boolean hasId()
        Checks whether the 'id' field has been set, however the value could be null
      • hasNumber

        public boolean hasNumber()
        Checks whether the 'number' field has been set, however the value could be null
      • hasEncryptedPan

        public boolean hasEncryptedPan()
        Checks whether the 'encrypted_pan' field has been set, however the value could be null
      • hasEncryptedTrack2

        public boolean hasEncryptedTrack2()
        Checks whether the 'encrypted_track2' field has been set, however the value could be null
      • hasEncryptedPanForBinLookup

        public boolean hasEncryptedPanForBinLookup()
        Checks whether the 'encrypted_pan_for_bin_lookup' field has been set, however the value could be null
      • hasTransarmorToken

        public boolean hasTransarmorToken()
        Checks whether the 'transarmor_token' field has been set, however the value could be null
      • hasTransarmorTokenType

        public boolean hasTransarmorTokenType()
        Checks whether the 'transarmor_token_type' field has been set, however the value could be null
      • hasTokenMetaId

        public boolean hasTokenMetaId()
        Checks whether the 'token_meta_id' field has been set, however the value could be null
      • hasTransarmorKeyId

        public boolean hasTransarmorKeyId()
        Checks whether the 'transarmor_key_id' field has been set, however the value could be null
      • hasExpMonth

        public boolean hasExpMonth()
        Checks whether the 'exp_month' field has been set, however the value could be null
      • hasExpYear

        public boolean hasExpYear()
        Checks whether the 'exp_year' field has been set, however the value could be null
      • hasCvv

        public boolean hasCvv()
        Checks whether the 'cvv' field has been set, however the value could be null
      • hasFirst6

        public boolean hasFirst6()
        Checks whether the 'first6' field has been set, however the value could be null
      • hasLast4

        public boolean hasLast4()
        Checks whether the 'last4' field has been set, however the value could be null
      • hasCountry

        public boolean hasCountry()
        Checks whether the 'country' field has been set, however the value could be null
      • hasBrand

        public boolean hasBrand()
        Checks whether the 'brand' field has been set, however the value could be null
      • hasFundingType

        public boolean hasFundingType()
        Checks whether the 'funding_type' field has been set, however the value could be null
      • hasIsPurchaseCard

        public boolean hasIsPurchaseCard()
        Checks whether the 'is_purchase_card' field has been set, however the value could be null
      • hasCreatedTime

        public boolean hasCreatedTime()
        Checks whether the 'created_time' field has been set, however the value could be null
      • hasModifiedTime

        public boolean hasModifiedTime()
        Checks whether the 'modified_time' field has been set, however the value could be null
      • hasObject

        public boolean hasObject()
        Checks whether the 'object' field has been set, however the value could be null
      • hasCvc

        public boolean hasCvc()
        Checks whether the 'cvc' field has been set, however the value could be null
      • hasCurrency

        public boolean hasCurrency()
        Checks whether the 'currency' field has been set, however the value could be null
      • hasName

        public boolean hasName()
        Checks whether the 'name' field has been set, however the value could be null
      • hasAddressLine1

        public boolean hasAddressLine1()
        Checks whether the 'address_line1' field has been set, however the value could be null
      • hasAddressLine1Check

        public boolean hasAddressLine1Check()
        Checks whether the 'address_line1_check' field has been set, however the value could be null
      • hasAddressLine2

        public boolean hasAddressLine2()
        Checks whether the 'address_line2' field has been set, however the value could be null
      • hasAddressCity

        public boolean hasAddressCity()
        Checks whether the 'address_city' field has been set, however the value could be null
      • hasAddressState

        public boolean hasAddressState()
        Checks whether the 'address_state' field has been set, however the value could be null
      • hasAddressZip

        public boolean hasAddressZip()
        Checks whether the 'address_zip' field has been set, however the value could be null
      • hasAddressZipCheck

        public boolean hasAddressZipCheck()
        Checks whether the 'address_zip_check' field has been set, however the value could be null
      • hasAddressCountry

        public boolean hasAddressCountry()
        Checks whether the 'address_country' field has been set, however the value could be null
      • hasCvcCheck

        public boolean hasCvcCheck()
        Checks whether the 'cvc_check' field has been set, however the value could be null
      • hasFingerprint

        public boolean hasFingerprint()
        Checks whether the 'fingerprint' field has been set, however the value could be null
      • setId

        public Card setId​(String id)
        Sets the field 'id'.
      • setNumber

        public Card setNumber​(String number)
        Sets the field 'number'.
      • setEncryptedPan

        public Card setEncryptedPan​(String encrypted_pan)
        Sets the field 'encrypted_pan'.
      • setEncryptedTrack2

        public Card setEncryptedTrack2​(String encrypted_track2)
        Sets the field 'encrypted_track2'.
      • setEncryptedPanForBinLookup

        public Card setEncryptedPanForBinLookup​(String encrypted_pan_for_bin_lookup)
        Sets the field 'encrypted_pan_for_bin_lookup'.
      • setTransarmorToken

        public Card setTransarmorToken​(String transarmor_token)
        Sets the field 'transarmor_token'.
      • setTransarmorTokenType

        public Card setTransarmorTokenType​(String transarmor_token_type)
        Sets the field 'transarmor_token_type'.
      • setTokenMetaId

        public Card setTokenMetaId​(Long token_meta_id)
        Sets the field 'token_meta_id'.
      • setTransarmorKeyId

        public Card setTransarmorKeyId​(String transarmor_key_id)
        Sets the field 'transarmor_key_id'.
      • setExpMonth

        public Card setExpMonth​(String exp_month)
        Sets the field 'exp_month'.
      • setExpYear

        public Card setExpYear​(String exp_year)
        Sets the field 'exp_year'.
      • setCvv

        public Card setCvv​(String cvv)
        Sets the field 'cvv'.
      • setFirst6

        public Card setFirst6​(String first6)
        Sets the field 'first6'.
      • setLast4

        public Card setLast4​(String last4)
        Sets the field 'last4'.
      • setCountry

        public Card setCountry​(String country)
        Sets the field 'country'.
      • setBrand

        public Card setBrand​(CardType brand)
        Sets the field 'brand'.
      • setFundingType

        public Card setFundingType​(FundingType funding_type)
        Sets the field 'funding_type'.
      • setIsPurchaseCard

        public Card setIsPurchaseCard​(Boolean is_purchase_card)
        Sets the field 'is_purchase_card'.
      • setCreatedTime

        public Card setCreatedTime​(Long created_time)
        Sets the field 'created_time'.
      • setModifiedTime

        public Card setModifiedTime​(Long modified_time)
        Sets the field 'modified_time'.
      • setObject

        public Card setObject​(String object)
        Sets the field 'object'.
      • setCvc

        public Card setCvc​(String cvc)
        Sets the field 'cvc'.
      • setCurrency

        public Card setCurrency​(String currency)
        Sets the field 'currency'.
      • setName

        public Card setName​(String name)
        Sets the field 'name'.
      • setAddressLine1

        public Card setAddressLine1​(String address_line1)
        Sets the field 'address_line1'.
      • setAddressLine1Check

        public Card setAddressLine1Check​(String address_line1_check)
        Sets the field 'address_line1_check'.
      • setAddressLine2

        public Card setAddressLine2​(String address_line2)
        Sets the field 'address_line2'.
      • setAddressCity

        public Card setAddressCity​(String address_city)
        Sets the field 'address_city'.
      • setAddressState

        public Card setAddressState​(String address_state)
        Sets the field 'address_state'.
      • setAddressZip

        public Card setAddressZip​(String address_zip)
        Sets the field 'address_zip'.
      • setAddressZipCheck

        public Card setAddressZipCheck​(String address_zip_check)
        Sets the field 'address_zip_check'.
      • setAddressCountry

        public Card setAddressCountry​(String address_country)
        Sets the field 'address_country'.
      • setCvcCheck

        public Card setCvcCheck​(String cvc_check)
        Sets the field 'cvc_check'.
      • setFingerprint

        public Card setFingerprint​(String fingerprint)
        Sets the field 'fingerprint'.
      • clearId

        public void clearId()
        Clears the 'id' field, the 'has' method for this field will now return false
      • clearNumber

        public void clearNumber()
        Clears the 'number' field, the 'has' method for this field will now return false
      • clearEncryptedPan

        public void clearEncryptedPan()
        Clears the 'encrypted_pan' field, the 'has' method for this field will now return false
      • clearEncryptedTrack2

        public void clearEncryptedTrack2()
        Clears the 'encrypted_track2' field, the 'has' method for this field will now return false
      • clearEncryptedPanForBinLookup

        public void clearEncryptedPanForBinLookup()
        Clears the 'encrypted_pan_for_bin_lookup' field, the 'has' method for this field will now return false
      • clearTransarmorToken

        public void clearTransarmorToken()
        Clears the 'transarmor_token' field, the 'has' method for this field will now return false
      • clearTransarmorTokenType

        public void clearTransarmorTokenType()
        Clears the 'transarmor_token_type' field, the 'has' method for this field will now return false
      • clearTokenMetaId

        public void clearTokenMetaId()
        Clears the 'token_meta_id' field, the 'has' method for this field will now return false
      • clearTransarmorKeyId

        public void clearTransarmorKeyId()
        Clears the 'transarmor_key_id' field, the 'has' method for this field will now return false
      • clearExpMonth

        public void clearExpMonth()
        Clears the 'exp_month' field, the 'has' method for this field will now return false
      • clearExpYear

        public void clearExpYear()
        Clears the 'exp_year' field, the 'has' method for this field will now return false
      • clearCvv

        public void clearCvv()
        Clears the 'cvv' field, the 'has' method for this field will now return false
      • clearFirst6

        public void clearFirst6()
        Clears the 'first6' field, the 'has' method for this field will now return false
      • clearLast4

        public void clearLast4()
        Clears the 'last4' field, the 'has' method for this field will now return false
      • clearCountry

        public void clearCountry()
        Clears the 'country' field, the 'has' method for this field will now return false
      • clearBrand

        public void clearBrand()
        Clears the 'brand' field, the 'has' method for this field will now return false
      • clearFundingType

        public void clearFundingType()
        Clears the 'funding_type' field, the 'has' method for this field will now return false
      • clearIsPurchaseCard

        public void clearIsPurchaseCard()
        Clears the 'is_purchase_card' field, the 'has' method for this field will now return false
      • clearCreatedTime

        public void clearCreatedTime()
        Clears the 'created_time' field, the 'has' method for this field will now return false
      • clearModifiedTime

        public void clearModifiedTime()
        Clears the 'modified_time' field, the 'has' method for this field will now return false
      • clearObject

        public void clearObject()
        Clears the 'object' field, the 'has' method for this field will now return false
      • clearCvc

        public void clearCvc()
        Clears the 'cvc' field, the 'has' method for this field will now return false
      • clearCurrency

        public void clearCurrency()
        Clears the 'currency' field, the 'has' method for this field will now return false
      • clearName

        public void clearName()
        Clears the 'name' field, the 'has' method for this field will now return false
      • clearAddressLine1

        public void clearAddressLine1()
        Clears the 'address_line1' field, the 'has' method for this field will now return false
      • clearAddressLine1Check

        public void clearAddressLine1Check()
        Clears the 'address_line1_check' field, the 'has' method for this field will now return false
      • clearAddressLine2

        public void clearAddressLine2()
        Clears the 'address_line2' field, the 'has' method for this field will now return false
      • clearAddressCity

        public void clearAddressCity()
        Clears the 'address_city' field, the 'has' method for this field will now return false
      • clearAddressState

        public void clearAddressState()
        Clears the 'address_state' field, the 'has' method for this field will now return false
      • clearAddressZip

        public void clearAddressZip()
        Clears the 'address_zip' field, the 'has' method for this field will now return false
      • clearAddressZipCheck

        public void clearAddressZipCheck()
        Clears the 'address_zip_check' field, the 'has' method for this field will now return false
      • clearAddressCountry

        public void clearAddressCountry()
        Clears the 'address_country' field, the 'has' method for this field will now return false
      • clearCvcCheck

        public void clearCvcCheck()
        Clears the 'cvc_check' field, the 'has' method for this field will now return false
      • clearFingerprint

        public void clearFingerprint()
        Clears the 'fingerprint' field, the 'has' method for this field will now return false
      • containsChanges

        public boolean containsChanges()
        Returns true if this instance has any changes.
      • resetChangeLog

        public void resetChangeLog()
        Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.
      • copyChanges

        public Card copyChanges()
        Create a copy of this instance that contains only fields that were set after the constructor was called.
      • mergeChanges

        public void mergeChanges​(Card src)
        Copy all the changed fields from the given source to this instance.