Package com.adyen.model.payment

Class PaymentRequest3ds2

  • public class PaymentRequest3ds2
extends Object
    PaymentRequest3ds2

    • Constructor Detail

      • PaymentRequest3ds2

        public PaymentRequest3ds2()

    • Method Detail

      • accountInfo

        public PaymentRequest3ds2 accountInfo​(AccountInfo accountInfo)
        accountInfo
        Parameters:
        accountInfo -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getAccountInfo

        public AccountInfo getAccountInfo()
        accountInfo
        Returns:
        accountInfo

      • setAccountInfo

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

      • additionalAmount

        public PaymentRequest3ds2 additionalAmount​(Amount additionalAmount)
        additionalAmount
        Parameters:
        additionalAmount -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getAdditionalAmount

        public Amount getAdditionalAmount()
        additionalAmount
        Returns:
        additionalAmount

      • setAdditionalAmount

        public void setAdditionalAmount​(Amount additionalAmount)
        additionalAmount
        Parameters:
        additionalAmount -

      • additionalData

        public PaymentRequest3ds2 additionalData​(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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • amount

        public PaymentRequest3ds2 amount​(Amount amount)
        amount
        Parameters:
        amount -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getAmount

        public Amount getAmount()
        amount
        Returns:
        amount

      • setAmount

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

      • applicationInfo

        public PaymentRequest3ds2 applicationInfo​(ApplicationInfo applicationInfo)
        applicationInfo
        Parameters:
        applicationInfo -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getApplicationInfo

        public ApplicationInfo getApplicationInfo()
        applicationInfo
        Returns:
        applicationInfo

      • setApplicationInfo

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

      • billingAddress

        public PaymentRequest3ds2 billingAddress​(Address billingAddress)
        billingAddress
        Parameters:
        billingAddress -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getBillingAddress

        public Address getBillingAddress()
        billingAddress
        Returns:
        billingAddress

      • setBillingAddress

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

      • browserInfo

        public PaymentRequest3ds2 browserInfo​(BrowserInfo browserInfo)
        browserInfo
        Parameters:
        browserInfo -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getBrowserInfo

        public BrowserInfo getBrowserInfo()
        browserInfo
        Returns:
        browserInfo

      • setBrowserInfo

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

      • captureDelayHours

        public PaymentRequest3ds2 captureDelayHours​(Integer captureDelayHours)
        The delay between the authorisation and scheduled auto-capture, specified in hours.
        Parameters:
        captureDelayHours -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • dateOfBirth

        public PaymentRequest3ds2 dateOfBirth​(LocalDate dateOfBirth)
        The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD
        Parameters:
        dateOfBirth -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • dccQuote

        public PaymentRequest3ds2 dccQuote​(ForexQuote dccQuote)
        dccQuote
        Parameters:
        dccQuote -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getDccQuote

        public ForexQuote getDccQuote()
        dccQuote
        Returns:
        dccQuote

      • setDccQuote

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

      • deliveryAddress

        public PaymentRequest3ds2 deliveryAddress​(Address deliveryAddress)
        deliveryAddress
        Parameters:
        deliveryAddress -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getDeliveryAddress

        public Address getDeliveryAddress()
        deliveryAddress
        Returns:
        deliveryAddress

      • setDeliveryAddress

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

      • deliveryDate

        public PaymentRequest3ds2 deliveryDate​(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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • deviceFingerprint

        public PaymentRequest3ds2 deviceFingerprint​(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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • fraudOffset

        public PaymentRequest3ds2 fraudOffset​(Integer fraudOffset)
        An integer value that is added to the normal fraud score. The value can be either positive or negative.
        Parameters:
        fraudOffset -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • installments

        public PaymentRequest3ds2 installments​(Installments installments)
        installments
        Parameters:
        installments -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getInstallments

        public Installments getInstallments()
        installments
        Returns:
        installments

      • setInstallments

        public void setInstallments​(Installments installments)
        installments
        Parameters:
        installments -

      • localizedShopperStatement

        public PaymentRequest3ds2 localizedShopperStatement​(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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • putLocalizedShopperStatementItem

        public PaymentRequest3ds2 putLocalizedShopperStatementItem​(String key,
                                                           String localizedShopperStatementItem)

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

      • mcc

        public PaymentRequest3ds2 mcc​(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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • merchantAccount

        public PaymentRequest3ds2 merchantAccount​(String merchantAccount)
        The merchant account identifier, with which you want to process the transaction.
        Parameters:
        merchantAccount -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • merchantOrderReference

        public PaymentRequest3ds2 merchantOrderReference​(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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • merchantRiskIndicator

        public PaymentRequest3ds2 merchantRiskIndicator​(MerchantRiskIndicator merchantRiskIndicator)
        merchantRiskIndicator
        Parameters:
        merchantRiskIndicator -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getMerchantRiskIndicator

        public MerchantRiskIndicator getMerchantRiskIndicator()
        merchantRiskIndicator
        Returns:
        merchantRiskIndicator

      • setMerchantRiskIndicator

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

      • metadata

        public PaymentRequest3ds2 metadata​(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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • orderReference

        public PaymentRequest3ds2 orderReference​(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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • recurring

        public PaymentRequest3ds2 recurring​(Recurring recurring)
        recurring
        Parameters:
        recurring -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getRecurring

        public Recurring getRecurring()
        recurring
        Returns:
        recurring

      • setRecurring

        public void setRecurring​(Recurring recurring)
        recurring
        Parameters:
        recurring -

      • recurringProcessingModel

        public PaymentRequest3ds2 recurringProcessingModel​(PaymentRequest3ds2.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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getRecurringProcessingModel

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

      • reference

        public PaymentRequest3ds2 reference​(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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • selectedBrand

        public PaymentRequest3ds2 selectedBrand​(String selectedBrand)
        Some payment methods require defining a value for this field to specify how to process the transaction. For the Bancontact payment method, it can be set to: * `maestro` (default), to be processed like a Maestro card, or * `bcmc`, to be processed like a Bancontact card.
        Parameters:
        selectedBrand -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getSelectedBrand

        public String getSelectedBrand()
        Some payment methods require defining a value for this field to specify how to process the transaction. For the Bancontact payment method, it can be set to: * `maestro` (default), to be processed like a Maestro card, or * `bcmc`, to be processed like a Bancontact card.
        Returns:
        selectedBrand

      • setSelectedBrand

        public void setSelectedBrand​(String selectedBrand)
        Some payment methods require defining a value for this field to specify how to process the transaction. For the Bancontact payment method, it can be set to: * `maestro` (default), to be processed like a Maestro card, or * `bcmc`, to be processed like a Bancontact card.
        Parameters:
        selectedBrand -

      • selectedRecurringDetailReference

        public PaymentRequest3ds2 selectedRecurringDetailReference​(String selectedRecurringDetailReference)
        The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.
        Parameters:
        selectedRecurringDetailReference -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getSelectedRecurringDetailReference

        public String getSelectedRecurringDetailReference()
        The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.
        Returns:
        selectedRecurringDetailReference

      • setSelectedRecurringDetailReference

        public void setSelectedRecurringDetailReference​(String selectedRecurringDetailReference)
        The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.
        Parameters:
        selectedRecurringDetailReference -

      • sessionId

        public PaymentRequest3ds2 sessionId​(String sessionId)
        A session ID used to identify a payment session.
        Parameters:
        sessionId -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getSessionId

        public String getSessionId()
        A session ID used to identify a payment session.
        Returns:
        sessionId

      • setSessionId

        public void setSessionId​(String sessionId)
        A session ID used to identify a payment session.
        Parameters:
        sessionId -

      • shopperEmail

        public PaymentRequest3ds2 shopperEmail​(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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • shopperIP

        public PaymentRequest3ds2 shopperIP​(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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • shopperInteraction

        public PaymentRequest3ds2 shopperInteraction​(PaymentRequest3ds2.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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getShopperInteraction

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

      • shopperLocale

        public PaymentRequest3ds2 shopperLocale​(String shopperLocale)
        The combination of a language code and a country code to specify the language to be used in the payment.
        Parameters:
        shopperLocale -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • shopperName

        public PaymentRequest3ds2 shopperName​(Name shopperName)
        shopperName
        Parameters:
        shopperName -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getShopperName

        public Name getShopperName()
        shopperName
        Returns:
        shopperName

      • setShopperName

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

      • shopperReference

        public PaymentRequest3ds2 shopperReference​(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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • shopperStatement

        public PaymentRequest3ds2 shopperStatement​(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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • socialSecurityNumber

        public PaymentRequest3ds2 socialSecurityNumber​(String socialSecurityNumber)
        The shopper's social security number.
        Parameters:
        socialSecurityNumber -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • splits

        public PaymentRequest3ds2 splits​(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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • store

        public PaymentRequest3ds2 store​(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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

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

      • telephoneNumber

        public PaymentRequest3ds2 telephoneNumber​(String telephoneNumber)
        The shopper's telephone number.
        Parameters:
        telephoneNumber -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getTelephoneNumber

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

      • setTelephoneNumber

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

      • threeDS2RequestData

        public PaymentRequest3ds2 threeDS2RequestData​(ThreeDS2RequestData threeDS2RequestData)
        threeDS2RequestData
        Parameters:
        threeDS2RequestData -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getThreeDS2RequestData

        public ThreeDS2RequestData getThreeDS2RequestData()
        threeDS2RequestData
        Returns:
        threeDS2RequestData

      • setThreeDS2RequestData

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

      • threeDS2Result

        public PaymentRequest3ds2 threeDS2Result​(ThreeDS2Result threeDS2Result)
        threeDS2Result
        Parameters:
        threeDS2Result -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getThreeDS2Result

        public ThreeDS2Result getThreeDS2Result()
        threeDS2Result
        Returns:
        threeDS2Result

      • setThreeDS2Result

        public void setThreeDS2Result​(ThreeDS2Result threeDS2Result)
        threeDS2Result
        Parameters:
        threeDS2Result -

      • threeDS2Token

        public PaymentRequest3ds2 threeDS2Token​(String threeDS2Token)
        The ThreeDS2Token that was returned in the /authorise call.
        Parameters:
        threeDS2Token -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getThreeDS2Token

        public String getThreeDS2Token()
        The ThreeDS2Token that was returned in the /authorise call.
        Returns:
        threeDS2Token

      • setThreeDS2Token

        public void setThreeDS2Token​(String threeDS2Token)
        The ThreeDS2Token that was returned in the /authorise call.
        Parameters:
        threeDS2Token -

      • threeDSAuthenticationOnly

        public PaymentRequest3ds2 threeDSAuthenticationOnly​(Boolean threeDSAuthenticationOnly)
        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 -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getThreeDSAuthenticationOnly

        public Boolean getThreeDSAuthenticationOnly()
        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

        public void setThreeDSAuthenticationOnly​(Boolean threeDSAuthenticationOnly)
        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 -

      • totalsGroup

        public PaymentRequest3ds2 totalsGroup​(String totalsGroup)
        The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).
        Parameters:
        totalsGroup -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • getTotalsGroup

        public String getTotalsGroup()
        The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).
        Returns:
        totalsGroup

      • setTotalsGroup

        public void setTotalsGroup​(String totalsGroup)
        The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).
        Parameters:
        totalsGroup -

      • trustedShopper

        public PaymentRequest3ds2 trustedShopper​(Boolean trustedShopper)
        Set to true if the payment should be routed to a trusted MID.
        Parameters:
        trustedShopper -
        Returns:
        the current PaymentRequest3ds2 instance, allowing for method chaining

      • 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 PaymentRequest3ds2 object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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