Package com.adyen.model.checkout

Class PaymentSetupRequest

  • public class PaymentSetupRequest
extends Object
    PaymentSetupRequest

    • Constructor Detail

      • PaymentSetupRequest

        public PaymentSetupRequest()

    • Method Detail

      • getAdditionalAmount

        public Amount getAdditionalAmount()
        Get additionalAmount
        Returns:
        additionalAmount

      • setAdditionalAmount

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

      • addAllowedPaymentMethodsItem

        public PaymentSetupRequest addAllowedPaymentMethodsItem​(String allowedPaymentMethodsItem)

      • getAllowedPaymentMethods

        public List<String> getAllowedPaymentMethods()
        List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`
        Returns:
        allowedPaymentMethods

      • setAllowedPaymentMethods

        public void setAllowedPaymentMethods​(List<String> allowedPaymentMethods)
        List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`
        Parameters:
        allowedPaymentMethods -

      • 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 -

      • getBillingAddress

        public Address getBillingAddress()
        Get billingAddress
        Returns:
        billingAddress

      • setBillingAddress

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

      • addBlockedPaymentMethodsItem

        public PaymentSetupRequest addBlockedPaymentMethodsItem​(String blockedPaymentMethodsItem)

      • getBlockedPaymentMethods

        public List<String> getBlockedPaymentMethods()
        List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`
        Returns:
        blockedPaymentMethods

      • setBlockedPaymentMethods

        public void setBlockedPaymentMethods​(List<String> blockedPaymentMethods)
        List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`
        Parameters:
        blockedPaymentMethods -

      • getCaptureDelayHours

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

      • setCaptureDelayHours

        public void setCaptureDelayHours​(Integer captureDelayHours)
        The delay between the authorisation and scheduled auto-capture, specified in hours.
        Parameters:
        captureDelayHours -

      • getChannel

        public PaymentSetupRequest.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​(PaymentSetupRequest.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 -

      • getCompany

        public Company getCompany()
        Get company
        Returns:
        company

      • setCompany

        public void setCompany​(Company company)
        company
        Parameters:
        company -

      • getConfiguration

        public ModelConfiguration getConfiguration()
        Get configuration
        Returns:
        configuration

      • setConfiguration

        public void setConfiguration​(ModelConfiguration configuration)
        configuration
        Parameters:
        configuration -

      • 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 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)
        The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD
        Parameters:
        dateOfBirth -

      • getDccQuote

        public ForexQuote getDccQuote()
        Get dccQuote
        Returns:
        dccQuote

      • setDccQuote

        public void setDccQuote​(ForexQuote dccQuote)
        dccQuote
        Parameters:
        dccQuote -

      • getDeliveryAddress

        public Address getDeliveryAddress()
        Get deliveryAddress
        Returns:
        deliveryAddress

      • setDeliveryAddress

        public void setDeliveryAddress​(Address deliveryAddress)
        deliveryAddress
        Parameters:
        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)
        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:
        deliveryDate -

      • 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)
        When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
        Parameters:
        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)
        When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
        Parameters:
        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)
        When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
        Parameters:
        enableRecurring -

      • setEntityType

        public void setEntityType​(PaymentSetupRequest.EntityTypeEnum entityType)
        The type of the entity the payment is processed for.
        Parameters:
        entityType -

      • 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)
        An integer value that is added to the normal fraud score. The value can be either positive or negative.
        Parameters:
        fraudOffset -

      • getInstallments

        public Installments getInstallments()
        Get installments
        Returns:
        installments

      • setInstallments

        public void setInstallments​(Installments installments)
        installments
        Parameters:
        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)
        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.
        Parameters:
        lineItems -

      • getLocalizedShopperStatement

        public Map<String,​String> getLocalizedShopperStatement()
        The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If not supplied, left empty, or for cross-border transactions, **shopperStatement** is used. Adyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports: * UTF-8 based Katakana, capital letters, numbers and special characters. * Half-width or full-width characters.
        Returns:
        localizedShopperStatement

      • setLocalizedShopperStatement

        public void setLocalizedShopperStatement​(Map<String,​String> localizedShopperStatement)
        The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If not supplied, left empty, or for cross-border transactions, **shopperStatement** is used. Adyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports: * UTF-8 based Katakana, capital letters, numbers and special characters. * Half-width or full-width characters.
        Parameters:
        localizedShopperStatement -

      • getMandate

        public Mandate getMandate()
        Get mandate
        Returns:
        mandate

      • setMandate

        public void setMandate​(Mandate mandate)
        mandate
        Parameters:
        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)
        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.
        Parameters:
        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)
        The merchant account identifier, with which you want to process the transaction.
        Parameters:
        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)
        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`.
        Parameters:
        merchantOrderReference -

      • 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 -

      • 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)
        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.
        Parameters:
        orderReference -

      • getOrigin

        public String getOrigin()
        Required for the Web integration. Set this parameter to the origin URL of the page that you are loading the SDK from.
        Returns:
        origin

      • setOrigin

        public void setOrigin​(String origin)
        Required for the Web integration. Set this parameter to the origin URL of the page that you are loading the SDK from.
        Parameters:
        origin -

      • getPlatformChargebackLogic

        public PlatformChargebackLogic getPlatformChargebackLogic()
        Get platformChargebackLogic
        Returns:
        platformChargebackLogic

      • setPlatformChargebackLogic

        public void setPlatformChargebackLogic​(PlatformChargebackLogic platformChargebackLogic)
        platformChargebackLogic
        Parameters:
        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)
        Date after which no further authorisations shall be performed. Only for 3D Secure 2.
        Parameters:
        recurringExpiry -

      • getRecurringFrequency

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

      • setRecurringFrequency

        public void setRecurringFrequency​(String recurringFrequency)
        Minimum number of days between authorisations. Only for 3D Secure 2.
        Parameters:
        recurringFrequency -

      • 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 -

      • getRiskData

        public RiskData getRiskData()
        Get riskData
        Returns:
        riskData

      • setRiskData

        public void setRiskData​(RiskData riskData)
        riskData
        Parameters:
        riskData -

      • getSdkVersion

        public String getSdkVersion()
        The version of the SDK you are using (for Web SDK integrations only).
        Returns:
        sdkVersion

      • setSdkVersion

        public void setSdkVersion​(String sdkVersion)
        The version of the SDK you are using (for Web SDK integrations only).
        Parameters:
        sdkVersion -

      • getSecureRemoteCommerceCheckoutData

        public SecureRemoteCommerceCheckoutData getSecureRemoteCommerceCheckoutData()
        Get secureRemoteCommerceCheckoutData
        Returns:
        secureRemoteCommerceCheckoutData

      • setSecureRemoteCommerceCheckoutData

        public void setSecureRemoteCommerceCheckoutData​(SecureRemoteCommerceCheckoutData secureRemoteCommerceCheckoutData)
        secureRemoteCommerceCheckoutData
        Parameters:
        secureRemoteCommerceCheckoutData -

      • 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 PaymentSetupRequest.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​(PaymentSetupRequest.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 -

      • 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)
        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 **. , ' _ - ? + * /_**.
        Parameters:
        shopperStatement -

      • 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 -

      • getSplits

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

      • setSplits

        public void setSplits​(List<Split> splits)
        An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).
        Parameters:
        splits -

      • getStore

        public String getStore()
        Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.
        Returns:
        store

      • setStore

        public void setStore​(String store)
        Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.
        Parameters:
        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)
        When true and `shopperReference` is provided, the payment details will be stored.
        Parameters:
        storePaymentMethod -

      • getTelephoneNumber

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

      • setTelephoneNumber

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

      • 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 -

      • getToken

        public String getToken()
        The token obtained when initializing the SDK. > This parameter is required for iOS and Android; not required for Web.
        Returns:
        token

      • setToken

        public void setToken​(String token)
        The token obtained when initializing the SDK. > This parameter is required for iOS and Android; not required for Web.
        Parameters:
        token -

      • 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)
        Set to true if the payment should be routed to a trusted MID.
        Parameters:
        trustedShopper -

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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