Package com.adyen.model.checkout

Class DonationPaymentRequest

  • public class DonationPaymentRequest
extends Object
    DonationPaymentRequest

    • Constructor Detail

      • DonationPaymentRequest

        public DonationPaymentRequest()

    • Method Detail

      • getAccountInfo

        public AccountInfo getAccountInfo()
        Get accountInfo
        Returns:
        accountInfo

      • setAccountInfo

        public void setAccountInfo​(AccountInfo accountInfo)
        accountInfo
        Parameters:
        accountInfo -

      • getAdditionalData

        public Map<String,​String> getAdditionalData()
        This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value.
        Returns:
        additionalData

      • setAdditionalData

        public void setAdditionalData​(Map<String,​String> additionalData)
        This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value.
        Parameters:
        additionalData -

      • getAmount

        public Amount getAmount()
        Get amount
        Returns:
        amount

      • setAmount

        public void setAmount​(Amount amount)
        amount
        Parameters:
        amount -

      • getApplicationInfo

        public ApplicationInfo getApplicationInfo()
        Get applicationInfo
        Returns:
        applicationInfo

      • setApplicationInfo

        public void setApplicationInfo​(ApplicationInfo applicationInfo)
        applicationInfo
        Parameters:
        applicationInfo -

      • getAuthenticationData

        public AuthenticationData getAuthenticationData()
        Get authenticationData
        Returns:
        authenticationData

      • setAuthenticationData

        public void setAuthenticationData​(AuthenticationData authenticationData)
        authenticationData
        Parameters:
        authenticationData -

      • getBillingAddress

        public BillingAddress getBillingAddress()
        Get billingAddress
        Returns:
        billingAddress

      • setBillingAddress

        public void setBillingAddress​(BillingAddress billingAddress)
        billingAddress
        Parameters:
        billingAddress -

      • getBrowserInfo

        public BrowserInfo getBrowserInfo()
        Get browserInfo
        Returns:
        browserInfo

      • setBrowserInfo

        public void setBrowserInfo​(BrowserInfo browserInfo)
        browserInfo
        Parameters:
        browserInfo -

      • getChannel

        public DonationPaymentRequest.ChannelEnum getChannel()
        The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`. Possible values: * iOS * Android * Web
        Returns:
        channel

      • setChannel

        public void setChannel​(DonationPaymentRequest.ChannelEnum channel)
        The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`. Possible values: * iOS * Android * Web
        Parameters:
        channel -

      • getCheckoutAttemptId

        public String getCheckoutAttemptId()
        Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
        Returns:
        checkoutAttemptId

      • setCheckoutAttemptId

        public void setCheckoutAttemptId​(String checkoutAttemptId)
        Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
        Parameters:
        checkoutAttemptId -

      • getConversionId

        @Deprecated
public String getConversionId()
        Deprecated.
        Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
        Returns:
        conversionId

      • setConversionId

        @Deprecated
public void setConversionId​(String conversionId)
        Deprecated.
        Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
        Parameters:
        conversionId -

      • getCountryCode

        public String getCountryCode()
        The shopper country. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE
        Returns:
        countryCode

      • setCountryCode

        public void setCountryCode​(String countryCode)
        The shopper country. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE
        Parameters:
        countryCode -

      • getDateOfBirth

        public OffsetDateTime getDateOfBirth()
        The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD
        Returns:
        dateOfBirth

      • setDateOfBirth

        public void setDateOfBirth​(OffsetDateTime dateOfBirth)
        The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD
        Parameters:
        dateOfBirth -

      • getDeliverAt

        public OffsetDateTime getDeliverAt()
        The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00
        Returns:
        deliverAt

      • setDeliverAt

        public void setDeliverAt​(OffsetDateTime deliverAt)
        The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00
        Parameters:
        deliverAt -

      • getDeliveryAddress

        public DeliveryAddress getDeliveryAddress()
        Get deliveryAddress
        Returns:
        deliveryAddress

      • setDeliveryAddress

        public void setDeliveryAddress​(DeliveryAddress deliveryAddress)
        deliveryAddress
        Parameters:
        deliveryAddress -

      • getDeviceFingerprint

        public String getDeviceFingerprint()
        A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
        Returns:
        deviceFingerprint

      • setDeviceFingerprint

        public void setDeviceFingerprint​(String deviceFingerprint)
        A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
        Parameters:
        deviceFingerprint -

      • getDonationAccount

        public String getDonationAccount()
        Donation account to which the transaction is credited.
        Returns:
        donationAccount

      • setDonationAccount

        public void setDonationAccount​(String donationAccount)
        Donation account to which the transaction is credited.
        Parameters:
        donationAccount -

      • getDonationOriginalPspReference

        public String getDonationOriginalPspReference()
        PSP reference of the transaction from which the donation token is generated. Required when `donationToken` is provided.
        Returns:
        donationOriginalPspReference

      • setDonationOriginalPspReference

        public void setDonationOriginalPspReference​(String donationOriginalPspReference)
        PSP reference of the transaction from which the donation token is generated. Required when `donationToken` is provided.
        Parameters:
        donationOriginalPspReference -

      • getDonationToken

        public String getDonationToken()
        Donation token received in the `/payments` call.
        Returns:
        donationToken

      • setDonationToken

        public void setDonationToken​(String donationToken)
        Donation token received in the `/payments` call.
        Parameters:
        donationToken -

      • getLineItems

        public List<LineItem> getLineItems()
        Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.
        Returns:
        lineItems

      • setLineItems

        public void setLineItems​(List<LineItem> lineItems)
        Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.
        Parameters:
        lineItems -

      • getMerchantAccount

        public String getMerchantAccount()
        The merchant account identifier, with which you want to process the transaction.
        Returns:
        merchantAccount

      • setMerchantAccount

        public void setMerchantAccount​(String merchantAccount)
        The merchant account identifier, with which you want to process the transaction.
        Parameters:
        merchantAccount -

      • getMerchantRiskIndicator

        public MerchantRiskIndicator getMerchantRiskIndicator()
        Get merchantRiskIndicator
        Returns:
        merchantRiskIndicator

      • setMerchantRiskIndicator

        public void setMerchantRiskIndicator​(MerchantRiskIndicator merchantRiskIndicator)
        merchantRiskIndicator
        Parameters:
        merchantRiskIndicator -

      • getMetadata

        public Map<String,​String> getMetadata()
        Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". * Maximum 20 characters per key. * Maximum 80 characters per value.
        Returns:
        metadata

      • setMetadata

        public void setMetadata​(Map<String,​String> metadata)
        Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". * Maximum 20 characters per key. * Maximum 80 characters per value.
        Parameters:
        metadata -

      • getMpiData

        public ThreeDSecureData getMpiData()
        Get mpiData
        Returns:
        mpiData

      • setMpiData

        public void setMpiData​(ThreeDSecureData mpiData)
        mpiData
        Parameters:
        mpiData -

      • getOrigin

        public String getOrigin()
        Required for the 3D Secure 2 `channel` **Web** integration. Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.
        Returns:
        origin

      • setOrigin

        public void setOrigin​(String origin)
        Required for the 3D Secure 2 `channel` **Web** integration. Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.
        Parameters:
        origin -

      • getPaymentMethod

        public DonationPaymentMethod getPaymentMethod()
        Get paymentMethod
        Returns:
        paymentMethod

      • setPaymentMethod

        public void setPaymentMethod​(DonationPaymentMethod paymentMethod)
        paymentMethod
        Parameters:
        paymentMethod -

      • getRecurringProcessingModel

        public DonationPaymentRequest.RecurringProcessingModelEnum getRecurringProcessingModel()
        Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.
        Returns:
        recurringProcessingModel

      • setRecurringProcessingModel

        public void setRecurringProcessingModel​(DonationPaymentRequest.RecurringProcessingModelEnum recurringProcessingModel)
        Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.
        Parameters:
        recurringProcessingModel -

      • getRedirectFromIssuerMethod

        public String getRedirectFromIssuerMethod()
        Specifies the redirect method (GET or POST) when redirecting back from the issuer.
        Returns:
        redirectFromIssuerMethod

      • setRedirectFromIssuerMethod

        public void setRedirectFromIssuerMethod​(String redirectFromIssuerMethod)
        Specifies the redirect method (GET or POST) when redirecting back from the issuer.
        Parameters:
        redirectFromIssuerMethod -

      • getRedirectToIssuerMethod

        public String getRedirectToIssuerMethod()
        Specifies the redirect method (GET or POST) when redirecting to the issuer.
        Returns:
        redirectToIssuerMethod

      • setRedirectToIssuerMethod

        public void setRedirectToIssuerMethod​(String redirectToIssuerMethod)
        Specifies the redirect method (GET or POST) when redirecting to the issuer.
        Parameters:
        redirectToIssuerMethod -

      • getReference

        public String getReference()
        The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.
        Returns:
        reference

      • setReference

        public void setReference​(String reference)
        The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.
        Parameters:
        reference -

      • getReturnUrl

        public String getReturnUrl()
        The URL to return to in case of a redirection. The format depends on the channel. This URL can have a maximum of 1024 characters. * For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: `https://your-company.com/checkout?shopperOrder=12xy` * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). Example: `my-app://` * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`
        Returns:
        returnUrl

      • setReturnUrl

        public void setReturnUrl​(String returnUrl)
        The URL to return to in case of a redirection. The format depends on the channel. This URL can have a maximum of 1024 characters. * For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: `https://your-company.com/checkout?shopperOrder=12xy` * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). Example: `my-app://` * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`
        Parameters:
        returnUrl -

      • getSessionValidity

        public String getSessionValidity()
        The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example: 2020-07-18T15:42:40.428+01:00
        Returns:
        sessionValidity

      • setSessionValidity

        public void setSessionValidity​(String sessionValidity)
        The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example: 2020-07-18T15:42:40.428+01:00
        Parameters:
        sessionValidity -

      • getShopperEmail

        public String getShopperEmail()
        The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.
        Returns:
        shopperEmail

      • setShopperEmail

        public void setShopperEmail​(String shopperEmail)
        The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.
        Parameters:
        shopperEmail -

      • getShopperIP

        public String getShopperIP()
        The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).
        Returns:
        shopperIP

      • setShopperIP

        public void setShopperIP​(String shopperIP)
        The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).
        Parameters:
        shopperIP -

      • getShopperInteraction

        public DonationPaymentRequest.ShopperInteractionEnum getShopperInteraction()
        Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
        Returns:
        shopperInteraction

      • setShopperInteraction

        public void setShopperInteraction​(DonationPaymentRequest.ShopperInteractionEnum shopperInteraction)
        Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
        Parameters:
        shopperInteraction -

      • getShopperLocale

        public String getShopperLocale()
        The combination of a language code and a country code to specify the language to be used in the payment.
        Returns:
        shopperLocale

      • setShopperLocale

        public void setShopperLocale​(String shopperLocale)
        The combination of a language code and a country code to specify the language to be used in the payment.
        Parameters:
        shopperLocale -

      • getShopperName

        public Name getShopperName()
        Get shopperName
        Returns:
        shopperName

      • setShopperName

        public void setShopperName​(Name shopperName)
        shopperName
        Parameters:
        shopperName -

      • getShopperReference

        public String getShopperReference()
        Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.
        Returns:
        shopperReference

      • setShopperReference

        public void setShopperReference​(String shopperReference)
        Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.
        Parameters:
        shopperReference -

      • getSocialSecurityNumber

        public String getSocialSecurityNumber()
        The shopper's social security number.
        Returns:
        socialSecurityNumber

      • setSocialSecurityNumber

        public void setSocialSecurityNumber​(String socialSecurityNumber)
        The shopper's social security number.
        Parameters:
        socialSecurityNumber -

      • getTelephoneNumber

        public String getTelephoneNumber()
        The shopper's telephone number.
        Returns:
        telephoneNumber

      • setTelephoneNumber

        public void setTelephoneNumber​(String telephoneNumber)
        The shopper's telephone number.
        Parameters:
        telephoneNumber -

      • getThreeDS2RequestData

        public ThreeDS2RequestFields getThreeDS2RequestData()
        Get threeDS2RequestData
        Returns:
        threeDS2RequestData

      • setThreeDS2RequestData

        public void setThreeDS2RequestData​(ThreeDS2RequestFields threeDS2RequestData)
        threeDS2RequestData
        Parameters:
        threeDS2RequestData -

      • getThreeDSAuthenticationOnly

        @Deprecated
public Boolean getThreeDSAuthenticationOnly()
        Deprecated.
        If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.
        Returns:
        threeDSAuthenticationOnly

      • setThreeDSAuthenticationOnly

        @Deprecated
public void setThreeDSAuthenticationOnly​(Boolean threeDSAuthenticationOnly)
        Deprecated.
        If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.
        Parameters:
        threeDSAuthenticationOnly -

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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