Class CardDonations


  • public class CardDonations
    extends Object
    CardDonations
    • Constructor Detail

      • CardDonations

        public CardDonations()
    • Method Detail

      • brand

        public CardDonations brand​(String brand)
        Secondary brand of the card. For example: **plastix**, **hmclub**.
        Parameters:
        brand -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getBrand

        public String getBrand()
        Secondary brand of the card. For example: **plastix**, **hmclub**.
        Returns:
        brand
      • setBrand

        public void setBrand​(String brand)
        Secondary brand of the card. For example: **plastix**, **hmclub**.
        Parameters:
        brand -
      • checkoutAttemptId

        public CardDonations checkoutAttemptId​(String checkoutAttemptId)
        The checkout attempt identifier.
        Parameters:
        checkoutAttemptId -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getCheckoutAttemptId

        public String getCheckoutAttemptId()
        The checkout attempt identifier.
        Returns:
        checkoutAttemptId
      • setCheckoutAttemptId

        public void setCheckoutAttemptId​(String checkoutAttemptId)
        The checkout attempt identifier.
        Parameters:
        checkoutAttemptId -
      • cupsecureplusSmscode

        @Deprecated
        public CardDonations cupsecureplusSmscode​(String cupsecureplusSmscode)
        Deprecated.
        cupsecureplusSmscode
        Parameters:
        cupsecureplusSmscode -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getCupsecureplusSmscode

        @Deprecated
        public String getCupsecureplusSmscode()
        Deprecated.
        cupsecureplusSmscode
        Returns:
        cupsecureplusSmscode
      • setCupsecureplusSmscode

        @Deprecated
        public void setCupsecureplusSmscode​(String cupsecureplusSmscode)
        Deprecated.
        cupsecureplusSmscode
        Parameters:
        cupsecureplusSmscode -
      • cvc

        public CardDonations cvc​(String cvc)
        The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
        Parameters:
        cvc -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getCvc

        public String getCvc()
        The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
        Returns:
        cvc
      • setCvc

        public void setCvc​(String cvc)
        The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
        Parameters:
        cvc -
      • encryptedCard

        public CardDonations encryptedCard​(String encryptedCard)
        Only include this for JSON Web Encryption (JWE) implementations. The JWE-encrypted card details.
        Parameters:
        encryptedCard -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getEncryptedCard

        public String getEncryptedCard()
        Only include this for JSON Web Encryption (JWE) implementations. The JWE-encrypted card details.
        Returns:
        encryptedCard
      • setEncryptedCard

        public void setEncryptedCard​(String encryptedCard)
        Only include this for JSON Web Encryption (JWE) implementations. The JWE-encrypted card details.
        Parameters:
        encryptedCard -
      • encryptedCardNumber

        public CardDonations encryptedCardNumber​(String encryptedCardNumber)
        The encrypted card number.
        Parameters:
        encryptedCardNumber -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getEncryptedCardNumber

        public String getEncryptedCardNumber()
        The encrypted card number.
        Returns:
        encryptedCardNumber
      • setEncryptedCardNumber

        public void setEncryptedCardNumber​(String encryptedCardNumber)
        The encrypted card number.
        Parameters:
        encryptedCardNumber -
      • encryptedExpiryMonth

        public CardDonations encryptedExpiryMonth​(String encryptedExpiryMonth)
        The encrypted card expiry month.
        Parameters:
        encryptedExpiryMonth -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getEncryptedExpiryMonth

        public String getEncryptedExpiryMonth()
        The encrypted card expiry month.
        Returns:
        encryptedExpiryMonth
      • setEncryptedExpiryMonth

        public void setEncryptedExpiryMonth​(String encryptedExpiryMonth)
        The encrypted card expiry month.
        Parameters:
        encryptedExpiryMonth -
      • encryptedExpiryYear

        public CardDonations encryptedExpiryYear​(String encryptedExpiryYear)
        The encrypted card expiry year.
        Parameters:
        encryptedExpiryYear -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getEncryptedExpiryYear

        public String getEncryptedExpiryYear()
        The encrypted card expiry year.
        Returns:
        encryptedExpiryYear
      • setEncryptedExpiryYear

        public void setEncryptedExpiryYear​(String encryptedExpiryYear)
        The encrypted card expiry year.
        Parameters:
        encryptedExpiryYear -
      • encryptedSecurityCode

        public CardDonations encryptedSecurityCode​(String encryptedSecurityCode)
        The encrypted card verification code.
        Parameters:
        encryptedSecurityCode -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getEncryptedSecurityCode

        public String getEncryptedSecurityCode()
        The encrypted card verification code.
        Returns:
        encryptedSecurityCode
      • setEncryptedSecurityCode

        public void setEncryptedSecurityCode​(String encryptedSecurityCode)
        The encrypted card verification code.
        Parameters:
        encryptedSecurityCode -
      • expiryMonth

        public CardDonations expiryMonth​(String expiryMonth)
        The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
        Parameters:
        expiryMonth -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getExpiryMonth

        public String getExpiryMonth()
        The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
        Returns:
        expiryMonth
      • setExpiryMonth

        public void setExpiryMonth​(String expiryMonth)
        The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
        Parameters:
        expiryMonth -
      • expiryYear

        public CardDonations expiryYear​(String expiryYear)
        The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
        Parameters:
        expiryYear -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getExpiryYear

        public String getExpiryYear()
        The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
        Returns:
        expiryYear
      • setExpiryYear

        public void setExpiryYear​(String expiryYear)
        The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
        Parameters:
        expiryYear -
      • fundingSource

        public CardDonations fundingSource​(CardDonations.FundingSourceEnum fundingSource)
        The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
        Parameters:
        fundingSource -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getFundingSource

        public CardDonations.FundingSourceEnum getFundingSource()
        The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
        Returns:
        fundingSource
      • setFundingSource

        public void setFundingSource​(CardDonations.FundingSourceEnum fundingSource)
        The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
        Parameters:
        fundingSource -
      • holderName

        public CardDonations holderName​(String holderName)
        The name of the card holder.
        Parameters:
        holderName -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getHolderName

        public String getHolderName()
        The name of the card holder.
        Returns:
        holderName
      • setHolderName

        public void setHolderName​(String holderName)
        The name of the card holder.
        Parameters:
        holderName -
      • networkPaymentReference

        public CardDonations networkPaymentReference​(String networkPaymentReference)
        The transaction identifier from card schemes. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.
        Parameters:
        networkPaymentReference -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getNetworkPaymentReference

        public String getNetworkPaymentReference()
        The transaction identifier from card schemes. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.
        Returns:
        networkPaymentReference
      • setNetworkPaymentReference

        public void setNetworkPaymentReference​(String networkPaymentReference)
        The transaction identifier from card schemes. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.
        Parameters:
        networkPaymentReference -
      • number

        public CardDonations number​(String number)
        The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
        Parameters:
        number -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getNumber

        public String getNumber()
        The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
        Returns:
        number
      • setNumber

        public void setNumber​(String number)
        The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
        Parameters:
        number -
      • recurringDetailReference

        @Deprecated
        public CardDonations recurringDetailReference​(String recurringDetailReference)
        Deprecated.
        since Adyen Checkout API v49 Use `storedPaymentMethodId` instead.
        This is the `recurringDetailReference` returned in the response when you created the token.
        Parameters:
        recurringDetailReference -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getRecurringDetailReference

        @Deprecated
        public String getRecurringDetailReference()
        Deprecated.
        since Adyen Checkout API v49 Use `storedPaymentMethodId` instead.
        This is the `recurringDetailReference` returned in the response when you created the token.
        Returns:
        recurringDetailReference
      • setRecurringDetailReference

        @Deprecated
        public void setRecurringDetailReference​(String recurringDetailReference)
        Deprecated.
        since Adyen Checkout API v49 Use `storedPaymentMethodId` instead.
        This is the `recurringDetailReference` returned in the response when you created the token.
        Parameters:
        recurringDetailReference -
      • shopperNotificationReference

        public CardDonations shopperNotificationReference​(String shopperNotificationReference)
        The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.
        Parameters:
        shopperNotificationReference -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getShopperNotificationReference

        public String getShopperNotificationReference()
        The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.
        Returns:
        shopperNotificationReference
      • setShopperNotificationReference

        public void setShopperNotificationReference​(String shopperNotificationReference)
        The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.
        Parameters:
        shopperNotificationReference -
      • srcCorrelationId

        public CardDonations srcCorrelationId​(String srcCorrelationId)
        An identifier used for the Click to Pay transaction.
        Parameters:
        srcCorrelationId -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getSrcCorrelationId

        public String getSrcCorrelationId()
        An identifier used for the Click to Pay transaction.
        Returns:
        srcCorrelationId
      • setSrcCorrelationId

        public void setSrcCorrelationId​(String srcCorrelationId)
        An identifier used for the Click to Pay transaction.
        Parameters:
        srcCorrelationId -
      • srcDigitalCardId

        public CardDonations srcDigitalCardId​(String srcDigitalCardId)
        The SRC reference for the Click to Pay token.
        Parameters:
        srcDigitalCardId -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getSrcDigitalCardId

        public String getSrcDigitalCardId()
        The SRC reference for the Click to Pay token.
        Returns:
        srcDigitalCardId
      • setSrcDigitalCardId

        public void setSrcDigitalCardId​(String srcDigitalCardId)
        The SRC reference for the Click to Pay token.
        Parameters:
        srcDigitalCardId -
      • srcScheme

        public CardDonations srcScheme​(String srcScheme)
        The scheme that is being used for Click to Pay.
        Parameters:
        srcScheme -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getSrcScheme

        public String getSrcScheme()
        The scheme that is being used for Click to Pay.
        Returns:
        srcScheme
      • setSrcScheme

        public void setSrcScheme​(String srcScheme)
        The scheme that is being used for Click to Pay.
        Parameters:
        srcScheme -
      • srcTokenReference

        public CardDonations srcTokenReference​(String srcTokenReference)
        The reference for the Click to Pay token.
        Parameters:
        srcTokenReference -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getSrcTokenReference

        public String getSrcTokenReference()
        The reference for the Click to Pay token.
        Returns:
        srcTokenReference
      • setSrcTokenReference

        public void setSrcTokenReference​(String srcTokenReference)
        The reference for the Click to Pay token.
        Parameters:
        srcTokenReference -
      • storedPaymentMethodId

        public CardDonations storedPaymentMethodId​(String storedPaymentMethodId)
        This is the `recurringDetailReference` returned in the response when you created the token.
        Parameters:
        storedPaymentMethodId -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getStoredPaymentMethodId

        public String getStoredPaymentMethodId()
        This is the `recurringDetailReference` returned in the response when you created the token.
        Returns:
        storedPaymentMethodId
      • setStoredPaymentMethodId

        public void setStoredPaymentMethodId​(String storedPaymentMethodId)
        This is the `recurringDetailReference` returned in the response when you created the token.
        Parameters:
        storedPaymentMethodId -
      • threeDS2SdkVersion

        public CardDonations threeDS2SdkVersion​(String threeDS2SdkVersion)
        Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.
        Parameters:
        threeDS2SdkVersion -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getThreeDS2SdkVersion

        public String getThreeDS2SdkVersion()
        Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.
        Returns:
        threeDS2SdkVersion
      • setThreeDS2SdkVersion

        public void setThreeDS2SdkVersion​(String threeDS2SdkVersion)
        Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.
        Parameters:
        threeDS2SdkVersion -
      • type

        public CardDonations type​(CardDonations.TypeEnum type)
        Default payment method details. Common for scheme payment methods, and for simple payment method details.
        Parameters:
        type -
        Returns:
        the current CardDonations instance, allowing for method chaining
      • getType

        public CardDonations.TypeEnum getType()
        Default payment method details. Common for scheme payment methods, and for simple payment method details.
        Returns:
        type
      • setType

        public void setType​(CardDonations.TypeEnum type)
        Default payment method details. Common for scheme payment methods, and for simple payment method details.
        Parameters:
        type -
      • equals

        public boolean equals​(Object o)
        Return true if this CardDonations object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • fromJson

        public static CardDonations fromJson​(String jsonString)
                                      throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of CardDonations given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of CardDonations
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to CardDonations
      • toJson

        public String toJson()
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of CardDonations to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException