Package com.checkout.handlepaymentsandpayouts.payments.common.source.cardsource

Class CardSource

  • public final class CardSource
extends AbstractSource
    card source Class The source of the payment

    • Field Summary

      • Fields inherited from class com.checkout.handlepaymentsandpayouts.payments.common.source.AbstractSource

        type

    • Constructor Summary

      Constructors 
      Constructor Description
      CardSource()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static CardSource.CardSourceBuilder builder()  
      protected boolean canEqual​(java.lang.Object other)  
      boolean equals​(java.lang.Object o)  
      AbstractAccountHolder getAccountHolder()
      Information about the account holder of the card [Optional]
      java.lang.String getAccountUpdateFailureCode()
      Provides the failure code if the Real-Time Account Updater fails to update the card information.
      AccountUpdateStatusType getAccountUpdateStatus()
      Specifies what card information was updated by the Real-Time Account Updater.
      java.lang.String getAvsCheck()
      The Address Verification System check result [Optional]
      BillingAddress getBillingAddress()
      The payment source owner's billing address [Optional]
      java.lang.String getBin()
      The card issuer's Bank Identification Number (BIN) [Required] <= 8
      CardCategoryType getCardCategory()
      The card category [Optional]
      CardType getCardType()
      The card type [Optional]
      CardWalletType getCardWalletType()
      The card wallet type [Optional]
      java.lang.String getCvvCheck()
      The card verification value (CVV) check result [Optional]
      java.lang.String getEncryptedCardNumber()
      The JWE encrypted full card number that has been updated by real-time account updater.
      java.lang.Integer getExpiryMonth()
      The expiry month [Required] [ 1 ..
      java.lang.Integer getExpiryYear()
      The expiry year [Required] 4 characters
      java.lang.String getFingerprint()
      Uniquely identifies this particular card number.
      java.lang.String getId()
      The payment source identifier that can be used for subsequent payments.
      java.lang.String getIssuer()
      The name of the card issuer [Optional]
      java.lang.String getIssuerCountry()
      The card issuer's country (two-letter ISO code) [Optional] 2 characters
      java.lang.String getLast4()
      The last four digits of the card number [Required]
      java.util.List<java.lang.String> getLocalSchemes()
      The local co-branded card schemes.
      java.lang.String getName()
      The cardholder's name [Optional]
      java.lang.String getPaymentAccountReference()
      A unique reference to the underlying card for network tokens (e.g., Apple Pay, Google Pay) [Optional]
      Phone getPhone()
      The payment source owner's phone number [Optional]
      java.lang.String getProductId()
      The issuer/card scheme product identifier [Optional]
      java.lang.String getProductType()
      The issuer/card scheme product type [Optional]
      java.lang.String getScheme()
      The card scheme [Optional]
      java.lang.String getSchemeLocal()
      Deprecated.
      int hashCode()  
      void setAccountHolder​(AbstractAccountHolder accountHolder)
      Information about the account holder of the card [Optional]
      void setAccountUpdateFailureCode​(java.lang.String accountUpdateFailureCode)
      Provides the failure code if the Real-Time Account Updater fails to update the card information.
      void setAccountUpdateStatus​(AccountUpdateStatusType accountUpdateStatus)
      Specifies what card information was updated by the Real-Time Account Updater.
      void setAvsCheck​(java.lang.String avsCheck)
      The Address Verification System check result [Optional]
      void setBillingAddress​(BillingAddress billingAddress)
      The payment source owner's billing address [Optional]
      void setBin​(java.lang.String bin)
      The card issuer's Bank Identification Number (BIN) [Required] <= 8
      void setCardCategory​(CardCategoryType cardCategory)
      The card category [Optional]
      void setCardType​(CardType cardType)
      The card type [Optional]
      void setCardWalletType​(CardWalletType cardWalletType)
      The card wallet type [Optional]
      void setCvvCheck​(java.lang.String cvvCheck)
      The card verification value (CVV) check result [Optional]
      void setEncryptedCardNumber​(java.lang.String encryptedCardNumber)
      The JWE encrypted full card number that has been updated by real-time account updater.
      void setExpiryMonth​(java.lang.Integer expiryMonth)
      The expiry month [Required] [ 1 ..
      void setExpiryYear​(java.lang.Integer expiryYear)
      The expiry year [Required] 4 characters
      void setFingerprint​(java.lang.String fingerprint)
      Uniquely identifies this particular card number.
      void setId​(java.lang.String id)
      The payment source identifier that can be used for subsequent payments.
      void setIssuer​(java.lang.String issuer)
      The name of the card issuer [Optional]
      void setIssuerCountry​(java.lang.String issuerCountry)
      The card issuer's country (two-letter ISO code) [Optional] 2 characters
      void setLast4​(java.lang.String last4)
      The last four digits of the card number [Required]
      void setLocalSchemes​(java.util.List<java.lang.String> localSchemes)
      The local co-branded card schemes.
      void setName​(java.lang.String name)
      The cardholder's name [Optional]
      void setPaymentAccountReference​(java.lang.String paymentAccountReference)
      A unique reference to the underlying card for network tokens (e.g., Apple Pay, Google Pay) [Optional]
      void setPhone​(Phone phone)
      The payment source owner's phone number [Optional]
      void setProductId​(java.lang.String productId)
      The issuer/card scheme product identifier [Optional]
      void setProductType​(java.lang.String productType)
      The issuer/card scheme product type [Optional]
      void setScheme​(java.lang.String scheme)
      The card scheme [Optional]
      void setSchemeLocal​(java.lang.String schemeLocal)
      Deprecated.
      java.lang.String toString()  

      • Methods inherited from class com.checkout.handlepaymentsandpayouts.payments.common.source.AbstractSource

        getType

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CardSource

        public CardSource()

    • Method Detail

      • getExpiryMonth

        public java.lang.Integer getExpiryMonth()
        The expiry month [Required] [ 1 .. 2 ] characters >= 1 >= 1

      • getExpiryYear

        public java.lang.Integer getExpiryYear()
        The expiry year [Required] 4 characters

      • getLast4

        public java.lang.String getLast4()
        The last four digits of the card number [Required]

      • getFingerprint

        public java.lang.String getFingerprint()
        Uniquely identifies this particular card number. You can use this to compare cards across customers. [Required]

      • getBin

        public java.lang.String getBin()
        The card issuer's Bank Identification Number (BIN) [Required] <= 8

      • getId

        public java.lang.String getId()
        The payment source identifier that can be used for subsequent payments. For new sources, this will only be returned if the payment was approved [Optional]

      • getBillingAddress

        public BillingAddress getBillingAddress()
        The payment source owner's billing address [Optional]

      • getPhone

        public Phone getPhone()
        The payment source owner's phone number [Optional]

      • getName

        public java.lang.String getName()
        The cardholder's name [Optional]

      • getScheme

        public java.lang.String getScheme()
        The card scheme [Optional]

      • getSchemeLocal

        @Deprecated
public java.lang.String getSchemeLocal()
        Deprecated.
        [DEPRECATED] Replaced by local_schemes The local co-branded card scheme. [Optional]

      • getLocalSchemes

        public java.util.List<java.lang.String> getLocalSchemes()
        The local co-branded card schemes. [Optional]

      • getCardType

        public CardType getCardType()
        The card type [Optional]

      • getCardCategory

        public CardCategoryType getCardCategory()
        The card category [Optional]

      • getCardWalletType

        public CardWalletType getCardWalletType()
        The card wallet type [Optional]

      • getIssuer

        public java.lang.String getIssuer()
        The name of the card issuer [Optional]

      • getIssuerCountry

        public java.lang.String getIssuerCountry()
        The card issuer's country (two-letter ISO code) [Optional] 2 characters

      • getProductId

        public java.lang.String getProductId()
        The issuer/card scheme product identifier [Optional]

      • getProductType

        public java.lang.String getProductType()
        The issuer/card scheme product type [Optional]

      • getAvsCheck

        public java.lang.String getAvsCheck()
        The Address Verification System check result [Optional]

      • getCvvCheck

        public java.lang.String getCvvCheck()
        The card verification value (CVV) check result [Optional]

      • getPaymentAccountReference

        public java.lang.String getPaymentAccountReference()
        A unique reference to the underlying card for network tokens (e.g., Apple Pay, Google Pay) [Optional]

      • getEncryptedCardNumber

        public java.lang.String getEncryptedCardNumber()
        The JWE encrypted full card number that has been updated by real-time account updater. [Optional]

      • getAccountUpdateStatus

        public AccountUpdateStatusType getAccountUpdateStatus()
        Specifies what card information was updated by the Real-Time Account Updater. [Optional]

      • getAccountUpdateFailureCode

        public java.lang.String getAccountUpdateFailureCode()
        Provides the failure code if the Real-Time Account Updater fails to update the card information. [Optional]

      • getAccountHolder

        public AbstractAccountHolder getAccountHolder()
        Information about the account holder of the card [Optional]

      • setExpiryMonth

        public void setExpiryMonth​(java.lang.Integer expiryMonth)
        The expiry month [Required] [ 1 .. 2 ] characters >= 1 >= 1

      • setExpiryYear

        public void setExpiryYear​(java.lang.Integer expiryYear)
        The expiry year [Required] 4 characters

      • setLast4

        public void setLast4​(java.lang.String last4)
        The last four digits of the card number [Required]

      • setFingerprint

        public void setFingerprint​(java.lang.String fingerprint)
        Uniquely identifies this particular card number. You can use this to compare cards across customers. [Required]

      • setBin

        public void setBin​(java.lang.String bin)
        The card issuer's Bank Identification Number (BIN) [Required] <= 8

      • setId

        public void setId​(java.lang.String id)
        The payment source identifier that can be used for subsequent payments. For new sources, this will only be returned if the payment was approved [Optional]

      • setBillingAddress

        public void setBillingAddress​(BillingAddress billingAddress)
        The payment source owner's billing address [Optional]

      • setPhone

        public void setPhone​(Phone phone)
        The payment source owner's phone number [Optional]

      • setName

        public void setName​(java.lang.String name)
        The cardholder's name [Optional]

      • setScheme

        public void setScheme​(java.lang.String scheme)
        The card scheme [Optional]

      • setSchemeLocal

        @Deprecated
public void setSchemeLocal​(java.lang.String schemeLocal)
        Deprecated.
        [DEPRECATED] Replaced by local_schemes The local co-branded card scheme. [Optional]

      • setLocalSchemes

        public void setLocalSchemes​(java.util.List<java.lang.String> localSchemes)
        The local co-branded card schemes. [Optional]

      • setCardType

        public void setCardType​(CardType cardType)
        The card type [Optional]

      • setCardCategory

        public void setCardCategory​(CardCategoryType cardCategory)
        The card category [Optional]

      • setCardWalletType

        public void setCardWalletType​(CardWalletType cardWalletType)
        The card wallet type [Optional]

      • setIssuer

        public void setIssuer​(java.lang.String issuer)
        The name of the card issuer [Optional]

      • setIssuerCountry

        public void setIssuerCountry​(java.lang.String issuerCountry)
        The card issuer's country (two-letter ISO code) [Optional] 2 characters

      • setProductId

        public void setProductId​(java.lang.String productId)
        The issuer/card scheme product identifier [Optional]

      • setProductType

        public void setProductType​(java.lang.String productType)
        The issuer/card scheme product type [Optional]

      • setAvsCheck

        public void setAvsCheck​(java.lang.String avsCheck)
        The Address Verification System check result [Optional]

      • setCvvCheck

        public void setCvvCheck​(java.lang.String cvvCheck)
        The card verification value (CVV) check result [Optional]

      • setPaymentAccountReference

        public void setPaymentAccountReference​(java.lang.String paymentAccountReference)
        A unique reference to the underlying card for network tokens (e.g., Apple Pay, Google Pay) [Optional]

      • setEncryptedCardNumber

        public void setEncryptedCardNumber​(java.lang.String encryptedCardNumber)
        The JWE encrypted full card number that has been updated by real-time account updater. [Optional]

      • setAccountUpdateStatus

        public void setAccountUpdateStatus​(AccountUpdateStatusType accountUpdateStatus)
        Specifies what card information was updated by the Real-Time Account Updater. [Optional]

      • setAccountUpdateFailureCode

        public void setAccountUpdateFailureCode​(java.lang.String accountUpdateFailureCode)
        Provides the failure code if the Real-Time Account Updater fails to update the card information. [Optional]

      • setAccountHolder

        public void setAccountHolder​(AbstractAccountHolder accountHolder)
        Information about the account holder of the card [Optional]

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class AbstractSource

      • canEqual

        protected boolean canEqual​(java.lang.Object other)
        Overrides:
        canEqual in class AbstractSource