Class PaymentDonationRequest


  • public class PaymentDonationRequest
    extends Object
    PaymentDonationRequest
    • Constructor Detail

      • PaymentDonationRequest

        public PaymentDonationRequest()
    • Method Detail

      • getAccountInfo

        public AccountInfo getAccountInfo()
        Get accountInfo
        Returns:
        accountInfo
      • setAccountInfo

        public void setAccountInfo​(AccountInfo accountInfo)
      • getAdditionalAmount

        public Amount getAdditionalAmount()
        Get additionalAmount
        Returns:
        additionalAmount
      • setAdditionalAmount

        public void setAdditionalAmount​(Amount additionalAmount)
      • 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)
      • getAmount

        public Amount getAmount()
        Get amount
        Returns:
        amount
      • setAmount

        public void setAmount​(Amount amount)
      • getApplicationInfo

        public ApplicationInfo getApplicationInfo()
        Get applicationInfo
        Returns:
        applicationInfo
      • setApplicationInfo

        public void setApplicationInfo​(ApplicationInfo applicationInfo)
      • getAuthenticationData

        public AuthenticationData getAuthenticationData()
        Get authenticationData
        Returns:
        authenticationData
      • setAuthenticationData

        public void setAuthenticationData​(AuthenticationData authenticationData)
      • getBillingAddress

        public Address getBillingAddress()
        Get billingAddress
        Returns:
        billingAddress
      • setBillingAddress

        public void setBillingAddress​(Address billingAddress)
      • getBrowserInfo

        public BrowserInfo getBrowserInfo()
        Get browserInfo
        Returns:
        browserInfo
      • setBrowserInfo

        public void setBrowserInfo​(BrowserInfo browserInfo)
      • getCaptureDelayHours

        public Integer getCaptureDelayHours()
        The delay between the authorisation and scheduled auto-capture, specified in hours.
        Returns:
        captureDelayHours
      • setCaptureDelayHours

        public void setCaptureDelayHours​(Integer captureDelayHours)
      • getChannel

        public PaymentDonationRequest.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
      • 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)
      • getCompany

        public Company getCompany()
        Get company
        Returns:
        company
      • setCompany

        public void setCompany​(Company company)
      • 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.
      • 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)
      • getDateOfBirth

        public LocalDate 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​(LocalDate dateOfBirth)
      • getDccQuote

        public ForexQuote getDccQuote()
        Get dccQuote
        Returns:
        dccQuote
      • setDccQuote

        public void setDccQuote​(ForexQuote dccQuote)
      • getDeliveryAddress

        public Address getDeliveryAddress()
        Get deliveryAddress
        Returns:
        deliveryAddress
      • setDeliveryAddress

        public void setDeliveryAddress​(Address deliveryAddress)
      • getDeliveryDate

        public OffsetDateTime getDeliveryDate()
        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:
        deliveryDate
      • setDeliveryDate

        public void setDeliveryDate​(OffsetDateTime deliveryDate)
      • 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)
      • getDonationAccount

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

        public void setDonationAccount​(String 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)
      • getDonationToken

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

        public void setDonationToken​(String donationToken)
      • getEnableOneClick

        public Boolean getEnableOneClick()
        When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
        Returns:
        enableOneClick
      • setEnableOneClick

        public void setEnableOneClick​(Boolean enableOneClick)
      • getEnablePayOut

        public Boolean getEnablePayOut()
        When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
        Returns:
        enablePayOut
      • setEnablePayOut

        public void setEnablePayOut​(Boolean enablePayOut)
      • getEnableRecurring

        public Boolean getEnableRecurring()
        When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
        Returns:
        enableRecurring
      • setEnableRecurring

        public void setEnableRecurring​(Boolean enableRecurring)
      • getFraudOffset

        public Integer getFraudOffset()
        An integer value that is added to the normal fraud score. The value can be either positive or negative.
        Returns:
        fraudOffset
      • setFraudOffset

        public void setFraudOffset​(Integer fraudOffset)
      • getIndustryUsage

        public PaymentDonationRequest.IndustryUsageEnum getIndustryUsage()
        The reason for the amount update. Possible values: * **delayedCharge** * **noShow** * **installment**
        Returns:
        industryUsage
      • getInstallments

        public Installments getInstallments()
        Get installments
        Returns:
        installments
      • setInstallments

        public void setInstallments​(Installments installments)
      • getLineItems

        public List<LineItem> getLineItems()
        Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.
        Returns:
        lineItems
      • setLineItems

        public void setLineItems​(List<LineItem> lineItems)
      • getLocalizedShopperStatement

        public Map<String,​String> getLocalizedShopperStatement()
        This field allows merchants to use dynamic shopper statement in local character sets. The local shopper statement field can be supplied in markets where localized merchant descriptors are used. Currently, Adyen only supports this in the Japanese market .The available character sets at the moment are: * Processing in Japan: **ja-Kana** The character set **ja-Kana** supports UTF-8 based Katakana and alphanumeric and special characters. Merchants can use half-width or full-width characters. An example request would be: > { \"shopperStatement\" : \"ADYEN - SELLER-A\", \"localizedShopperStatement\" : { \"ja-Kana\" : \"ADYEN - セラーA\" } } We recommend merchants to always supply the field localizedShopperStatement in addition to the field shopperStatement.It is issuer dependent whether the localized shopper statement field is supported. In the case of non-domestic transactions (e.g. US-issued cards processed in JP) the field `shopperStatement` is used to modify the statement of the shopper. Adyen handles the complexity of ensuring the correct descriptors are assigned. Please note, this field can be used for only Visa and Mastercard transactions.
        Returns:
        localizedShopperStatement
      • setLocalizedShopperStatement

        public void setLocalizedShopperStatement​(Map<String,​String> localizedShopperStatement)
      • getMandate

        public Mandate getMandate()
        Get mandate
        Returns:
        mandate
      • setMandate

        public void setMandate​(Mandate mandate)
      • getMcc

        public String getMcc()
        The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
        Returns:
        mcc
      • setMcc

        public void setMcc​(String mcc)
      • getMerchantAccount

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

        public void setMerchantAccount​(String merchantAccount)
      • getMerchantOrderReference

        public String getMerchantOrderReference()
        This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.
        Returns:
        merchantOrderReference
      • setMerchantOrderReference

        public void setMerchantOrderReference​(String merchantOrderReference)
      • getMerchantRiskIndicator

        public MerchantRiskIndicator getMerchantRiskIndicator()
        Get merchantRiskIndicator
        Returns:
        merchantRiskIndicator
      • setMerchantRiskIndicator

        public void setMerchantRiskIndicator​(MerchantRiskIndicator 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)
      • getMpiData

        public ThreeDSecureData getMpiData()
        Get mpiData
        Returns:
        mpiData
      • getOrderReference

        public String getOrderReference()
        When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead.
        Returns:
        orderReference
      • setOrderReference

        public void setOrderReference​(String orderReference)
      • 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)
      • getPaymentMethod

        public CheckoutPaymentMethod getPaymentMethod()
        Get paymentMethod
        Returns:
        paymentMethod
      • getPlatformChargebackLogic

        public PlatformChargebackLogic getPlatformChargebackLogic()
        Get platformChargebackLogic
        Returns:
        platformChargebackLogic
      • setPlatformChargebackLogic

        public void setPlatformChargebackLogic​(PlatformChargebackLogic platformChargebackLogic)
      • getRecurringExpiry

        public String getRecurringExpiry()
        Date after which no further authorisations shall be performed. Only for 3D Secure 2.
        Returns:
        recurringExpiry
      • setRecurringExpiry

        public void setRecurringExpiry​(String recurringExpiry)
      • getRecurringFrequency

        public String getRecurringFrequency()
        Minimum number of days between authorisations. Only for 3D Secure 2.
        Returns:
        recurringFrequency
      • setRecurringFrequency

        public void setRecurringFrequency​(String recurringFrequency)
      • getRecurringProcessingModel

        public PaymentDonationRequest.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
      • 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)
      • getRedirectToIssuerMethod

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

        public void setRedirectToIssuerMethod​(String 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)
      • 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)
      • getRiskData

        public RiskData getRiskData()
        Get riskData
        Returns:
        riskData
      • setRiskData

        public void setRiskData​(RiskData riskData)
      • 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)
      • 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)
      • 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)
      • getShopperInteraction

        public PaymentDonationRequest.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
      • 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)
      • getShopperName

        public Name getShopperName()
        Get shopperName
        Returns:
        shopperName
      • setShopperName

        public void setShopperName​(Name 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)
      • getShopperStatement

        public String getShopperStatement()
        The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**.
        Returns:
        shopperStatement
      • setShopperStatement

        public void setShopperStatement​(String shopperStatement)
      • getSocialSecurityNumber

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

        public void setSocialSecurityNumber​(String socialSecurityNumber)
      • getSplits

        public List<Split> getSplits()
        An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).
        Returns:
        splits
      • setSplits

        public void setSplits​(List<Split> splits)
      • getStore

        public String getStore()
        The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.
        Returns:
        store
      • setStore

        public void setStore​(String store)
      • getStorePaymentMethod

        public Boolean getStorePaymentMethod()
        When true and `shopperReference` is provided, the payment details will be stored.
        Returns:
        storePaymentMethod
      • setStorePaymentMethod

        public void setStorePaymentMethod​(Boolean storePaymentMethod)
      • getTelephoneNumber

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

        public void setTelephoneNumber​(String telephoneNumber)
      • getThreeDS2RequestData

        public ThreeDS2RequestData getThreeDS2RequestData()
        Get threeDS2RequestData
        Returns:
        threeDS2RequestData
      • setThreeDS2RequestData

        public void setThreeDS2RequestData​(ThreeDS2RequestData 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.
      • getTrustedShopper

        public Boolean getTrustedShopper()
        Set to true if the payment should be routed to a trusted MID.
        Returns:
        trustedShopper
      • setTrustedShopper

        public void setTrustedShopper​(Boolean trustedShopper)
      • hashCode

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

        public static void validateJsonObject​(com.google.gson.JsonObject jsonObj)
                                       throws IOException
        Validates the JSON Object and throws an exception if issues found
        Parameters:
        jsonObj - JSON Object
        Throws:
        IOException - if the JSON Object is invalid with respect to PaymentDonationRequest
      • fromJson

        public static PaymentDonationRequest fromJson​(String jsonString)
                                               throws IOException
        Create an instance of PaymentDonationRequest given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of PaymentDonationRequest
        Throws:
        IOException - if the JSON string is invalid with respect to PaymentDonationRequest
      • toJson

        public String toJson()
        Convert an instance of PaymentDonationRequest to an JSON string
        Returns:
        JSON string