Class PaymentRequest


  • public class PaymentRequest
    extends Object
    PaymentRequest
    • Constructor Detail

      • PaymentRequest

        public PaymentRequest()
    • Method Detail

      • accountInfo

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

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

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

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

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

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

        public PaymentRequest 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 - 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:
        the current PaymentRequest 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 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.
      • 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 - 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.
      • amount

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

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

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

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

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

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

        public PaymentRequest authenticationData​(AuthenticationData authenticationData)
        authenticationData
        Parameters:
        authenticationData -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getAuthenticationData

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

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

        public PaymentRequest bankAccount​(CheckoutBankAccount bankAccount)
        bankAccount
        Parameters:
        bankAccount -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getBankAccount

        public CheckoutBankAccount getBankAccount()
        Get bankAccount
        Returns:
        bankAccount
      • setBankAccount

        public void setBankAccount​(CheckoutBankAccount bankAccount)
        bankAccount
        Parameters:
        bankAccount -
      • billingAddress

        public PaymentRequest billingAddress​(BillingAddress billingAddress)
        billingAddress
        Parameters:
        billingAddress -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getBillingAddress

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

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

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

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

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

        public PaymentRequest captureDelayHours​(Integer captureDelayHours)
        The [delay between the authorization and automatic capture](https://docs.adyen.com/online-payments/capture?tab=delayed-individual_2#delayed-automatic-capture) of the payment, specified in hours. Maximum value: **672** (28 days).
        Parameters:
        captureDelayHours - The [delay between the authorization and automatic capture](https://docs.adyen.com/online-payments/capture?tab=delayed-individual_2#delayed-automatic-capture) of the payment, specified in hours. Maximum value: **672** (28 days).
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getCaptureDelayHours

        public Integer getCaptureDelayHours()
        The [delay between the authorization and automatic capture](https://docs.adyen.com/online-payments/capture?tab=delayed-individual_2#delayed-automatic-capture) of the payment, specified in hours. Maximum value: **672** (28 days).
        Returns:
        captureDelayHours The [delay between the authorization and automatic capture](https://docs.adyen.com/online-payments/capture?tab=delayed-individual_2#delayed-automatic-capture) of the payment, specified in hours. Maximum value: **672** (28 days).
      • setCaptureDelayHours

        public void setCaptureDelayHours​(Integer captureDelayHours)
        The [delay between the authorization and automatic capture](https://docs.adyen.com/online-payments/capture?tab=delayed-individual_2#delayed-automatic-capture) of the payment, specified in hours. Maximum value: **672** (28 days).
        Parameters:
        captureDelayHours - The [delay between the authorization and automatic capture](https://docs.adyen.com/online-payments/capture?tab=delayed-individual_2#delayed-automatic-capture) of the payment, specified in hours. Maximum value: **672** (28 days).
      • channel

        public PaymentRequest channel​(PaymentRequest.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 - 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:
        the current PaymentRequest instance, allowing for method chaining
      • getChannel

        public PaymentRequest.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 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
      • setChannel

        public void setChannel​(PaymentRequest.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 - 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
      • checkoutAttemptId

        public PaymentRequest checkoutAttemptId​(String checkoutAttemptId)
        Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
        Parameters:
        checkoutAttemptId - Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getCheckoutAttemptId

        public String getCheckoutAttemptId()
        Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
        Returns:
        checkoutAttemptId Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
      • 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 - Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
      • company

        public PaymentRequest company​(Company company)
        company
        Parameters:
        company -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getCompany

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

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

        @Deprecated
        public PaymentRequest conversionId​(String conversionId)
        Deprecated.
        since Adyen Checkout API v68 Use `checkoutAttemptId` instead
        Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
        Parameters:
        conversionId - Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getConversionId

        @Deprecated
        public String getConversionId()
        Deprecated.
        since Adyen Checkout API v68 Use `checkoutAttemptId` instead
        Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
        Returns:
        conversionId Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
      • setConversionId

        @Deprecated
        public void setConversionId​(String conversionId)
        Deprecated.
        since Adyen Checkout API v68 Use `checkoutAttemptId` instead
        Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
        Parameters:
        conversionId - Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
      • countryCode

        public PaymentRequest countryCode​(String countryCode)
        The shopper country code. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE
        Parameters:
        countryCode - The shopper country code. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getCountryCode

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

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

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

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

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

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

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

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

        public PaymentRequest deliverAt​(OffsetDateTime deliverAt)
        The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00
        Parameters:
        deliverAt - 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:
        the current PaymentRequest instance, allowing for method chaining
      • getDeliverAt

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

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

        public PaymentRequest deliveryAddress​(DeliveryAddress deliveryAddress)
        deliveryAddress
        Parameters:
        deliveryAddress -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getDeliveryAddress

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

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

        @Deprecated
        public PaymentRequest deliveryDate​(OffsetDateTime deliveryDate)
        Deprecated.
        since Adyen Checkout API v70 Use `deliverAt` instead.
        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 - 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:
        the current PaymentRequest instance, allowing for method chaining
      • getDeliveryDate

        @Deprecated
        public OffsetDateTime getDeliveryDate()
        Deprecated.
        since Adyen Checkout API v70 Use `deliverAt` instead.
        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 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
      • setDeliveryDate

        @Deprecated
        public void setDeliveryDate​(OffsetDateTime deliveryDate)
        Deprecated.
        since Adyen Checkout API v70 Use `deliverAt` instead.
        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 - 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
      • deviceFingerprint

        public PaymentRequest 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 - A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
        Returns:
        the current PaymentRequest 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 A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
      • 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 - A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
      • enableOneClick

        public PaymentRequest enableOneClick​(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](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
        Parameters:
        enableOneClick - When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future [one-click payments](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • 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](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
        Returns:
        enableOneClick When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future [one-click payments](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
      • 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](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
        Parameters:
        enableOneClick - When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future [one-click payments](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
      • enablePayOut

        public PaymentRequest enablePayOut​(Boolean enablePayOut)
        When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
        Parameters:
        enablePayOut - When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getEnablePayOut

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

        public void setEnablePayOut​(Boolean enablePayOut)
        When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
        Parameters:
        enablePayOut - When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
      • enableRecurring

        public PaymentRequest enableRecurring​(Boolean enableRecurring)
        When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments.
        Parameters:
        enableRecurring - When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments.
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getEnableRecurring

        public Boolean getEnableRecurring()
        When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments.
        Returns:
        enableRecurring When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments.
      • setEnableRecurring

        public void setEnableRecurring​(Boolean enableRecurring)
        When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments.
        Parameters:
        enableRecurring - When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments.
      • enhancedSchemeData

        public PaymentRequest enhancedSchemeData​(EnhancedSchemeData enhancedSchemeData)
        enhancedSchemeData
        Parameters:
        enhancedSchemeData -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getEnhancedSchemeData

        public EnhancedSchemeData getEnhancedSchemeData()
        Get enhancedSchemeData
        Returns:
        enhancedSchemeData
      • setEnhancedSchemeData

        public void setEnhancedSchemeData​(EnhancedSchemeData enhancedSchemeData)
        enhancedSchemeData
        Parameters:
        enhancedSchemeData -
      • entityType

        public PaymentRequest entityType​(PaymentRequest.EntityTypeEnum entityType)
        The type of the entity the payment is processed for.
        Parameters:
        entityType - The type of the entity the payment is processed for.
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getEntityType

        public PaymentRequest.EntityTypeEnum getEntityType()
        The type of the entity the payment is processed for.
        Returns:
        entityType The type of the entity the payment is processed for.
      • setEntityType

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

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

        public PaymentRequest fundOrigin​(FundOrigin fundOrigin)
        fundOrigin
        Parameters:
        fundOrigin -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getFundOrigin

        public FundOrigin getFundOrigin()
        Get fundOrigin
        Returns:
        fundOrigin
      • setFundOrigin

        public void setFundOrigin​(FundOrigin fundOrigin)
        fundOrigin
        Parameters:
        fundOrigin -
      • fundRecipient

        public PaymentRequest fundRecipient​(FundRecipient fundRecipient)
        fundRecipient
        Parameters:
        fundRecipient -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getFundRecipient

        public FundRecipient getFundRecipient()
        Get fundRecipient
        Returns:
        fundRecipient
      • setFundRecipient

        public void setFundRecipient​(FundRecipient fundRecipient)
        fundRecipient
        Parameters:
        fundRecipient -
      • industryUsage

        public PaymentRequest industryUsage​(PaymentRequest.IndustryUsageEnum industryUsage)
        The reason for the amount update. Possible values: * **delayedCharge** * **noShow** * **installment**
        Parameters:
        industryUsage - The reason for the amount update. Possible values: * **delayedCharge** * **noShow** * **installment**
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getIndustryUsage

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

        public void setIndustryUsage​(PaymentRequest.IndustryUsageEnum industryUsage)
        The reason for the amount update. Possible values: * **delayedCharge** * **noShow** * **installment**
        Parameters:
        industryUsage - The reason for the amount update. Possible values: * **delayedCharge** * **noShow** * **installment**
      • installments

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

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

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

        public PaymentRequest lineItems​(List<LineItem> lineItems)
        Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Riverty.
        Parameters:
        lineItems - Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Riverty.
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getLineItems

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

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

        public PaymentRequest localizedShopperStatement​(Map<String,​String> localizedShopperStatement)
        The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If this parameter is left empty, not provided, or not applicable (in case of cross-border transactions), then **shopperStatement** is used. Currently, `localizedShopperStatement` is only supported for payments with Visa, Mastercard, JCB, Diners, and Discover. **Supported characters**: Hiragana, Katakana, Kanji, and alphanumeric.
        Parameters:
        localizedShopperStatement - The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If this parameter is left empty, not provided, or not applicable (in case of cross-border transactions), then **shopperStatement** is used. Currently, `localizedShopperStatement` is only supported for payments with Visa, Mastercard, JCB, Diners, and Discover. **Supported characters**: Hiragana, Katakana, Kanji, and alphanumeric.
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • putLocalizedShopperStatementItem

        public PaymentRequest 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 this parameter is left empty, not provided, or not applicable (in case of cross-border transactions), then **shopperStatement** is used. Currently, `localizedShopperStatement` is only supported for payments with Visa, Mastercard, JCB, Diners, and Discover. **Supported characters**: Hiragana, Katakana, Kanji, and alphanumeric.
        Returns:
        localizedShopperStatement The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If this parameter is left empty, not provided, or not applicable (in case of cross-border transactions), then **shopperStatement** is used. Currently, `localizedShopperStatement` is only supported for payments with Visa, Mastercard, JCB, Diners, and Discover. **Supported characters**: Hiragana, Katakana, Kanji, and alphanumeric.
      • 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 this parameter is left empty, not provided, or not applicable (in case of cross-border transactions), then **shopperStatement** is used. Currently, `localizedShopperStatement` is only supported for payments with Visa, Mastercard, JCB, Diners, and Discover. **Supported characters**: Hiragana, Katakana, Kanji, and alphanumeric.
        Parameters:
        localizedShopperStatement - The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If this parameter is left empty, not provided, or not applicable (in case of cross-border transactions), then **shopperStatement** is used. Currently, `localizedShopperStatement` is only supported for payments with Visa, Mastercard, JCB, Diners, and Discover. **Supported characters**: Hiragana, Katakana, Kanji, and alphanumeric.
      • mandate

        public PaymentRequest mandate​(Mandate mandate)
        mandate
        Parameters:
        mandate -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getMandate

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

        public void setMandate​(Mandate mandate)
        mandate
        Parameters:
        mandate -
      • mcc

        public PaymentRequest 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 - 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:
        the current PaymentRequest 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 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.
      • 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 - 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.
      • merchantAccount

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

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

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

        public PaymentRequest merchantOrderReference​(String merchantOrderReference)
        You can use this reference to link multiple transactions to one another (for example, to track order authorization rate).For each billing cycle, this reference should be unique. After the first authorized payment attempt, do not reuse the reference. If you use this parameter, include it in all of the payment requests that you make. We strongly recommend that you: * Always include this parameter, so that you can benefit from linking payment requests to one another, in case of authorization retries. * Additionally include the following parameters in the `additionalData` object: [`retry.orderAttemptNumber`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-orderAttemptNumber), [`retry.chainAttemptNumber`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-chainAttemptNumber), and [`retry.skipRetry`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-skipRetry)
        Parameters:
        merchantOrderReference - You can use this reference to link multiple transactions to one another (for example, to track order authorization rate).For each billing cycle, this reference should be unique. After the first authorized payment attempt, do not reuse the reference. If you use this parameter, include it in all of the payment requests that you make. We strongly recommend that you: * Always include this parameter, so that you can benefit from linking payment requests to one another, in case of authorization retries. * Additionally include the following parameters in the `additionalData` object: [`retry.orderAttemptNumber`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-orderAttemptNumber), [`retry.chainAttemptNumber`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-chainAttemptNumber), and [`retry.skipRetry`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-skipRetry)
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getMerchantOrderReference

        public String getMerchantOrderReference()
        You can use this reference to link multiple transactions to one another (for example, to track order authorization rate).For each billing cycle, this reference should be unique. After the first authorized payment attempt, do not reuse the reference. If you use this parameter, include it in all of the payment requests that you make. We strongly recommend that you: * Always include this parameter, so that you can benefit from linking payment requests to one another, in case of authorization retries. * Additionally include the following parameters in the `additionalData` object: [`retry.orderAttemptNumber`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-orderAttemptNumber), [`retry.chainAttemptNumber`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-chainAttemptNumber), and [`retry.skipRetry`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-skipRetry)
        Returns:
        merchantOrderReference You can use this reference to link multiple transactions to one another (for example, to track order authorization rate).For each billing cycle, this reference should be unique. After the first authorized payment attempt, do not reuse the reference. If you use this parameter, include it in all of the payment requests that you make. We strongly recommend that you: * Always include this parameter, so that you can benefit from linking payment requests to one another, in case of authorization retries. * Additionally include the following parameters in the `additionalData` object: [`retry.orderAttemptNumber`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-orderAttemptNumber), [`retry.chainAttemptNumber`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-chainAttemptNumber), and [`retry.skipRetry`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-skipRetry)
      • setMerchantOrderReference

        public void setMerchantOrderReference​(String merchantOrderReference)
        You can use this reference to link multiple transactions to one another (for example, to track order authorization rate).For each billing cycle, this reference should be unique. After the first authorized payment attempt, do not reuse the reference. If you use this parameter, include it in all of the payment requests that you make. We strongly recommend that you: * Always include this parameter, so that you can benefit from linking payment requests to one another, in case of authorization retries. * Additionally include the following parameters in the `additionalData` object: [`retry.orderAttemptNumber`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-orderAttemptNumber), [`retry.chainAttemptNumber`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-chainAttemptNumber), and [`retry.skipRetry`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-skipRetry)
        Parameters:
        merchantOrderReference - You can use this reference to link multiple transactions to one another (for example, to track order authorization rate).For each billing cycle, this reference should be unique. After the first authorized payment attempt, do not reuse the reference. If you use this parameter, include it in all of the payment requests that you make. We strongly recommend that you: * Always include this parameter, so that you can benefit from linking payment requests to one another, in case of authorization retries. * Additionally include the following parameters in the `additionalData` object: [`retry.orderAttemptNumber`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-orderAttemptNumber), [`retry.chainAttemptNumber`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-chainAttemptNumber), and [`retry.skipRetry`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-skipRetry)
      • merchantRiskIndicator

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

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

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

        public PaymentRequest 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 - 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:
        the current PaymentRequest 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 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.
      • 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 - 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.
      • mpiData

        public PaymentRequest mpiData​(ThreeDSecureData mpiData)
        mpiData
        Parameters:
        mpiData -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getMpiData

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

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

        public PaymentRequest order​(EncryptedOrderData order)
        order
        Parameters:
        order -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • orderReference

        public PaymentRequest 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 - 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:
        the current PaymentRequest 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 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.
      • 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 - 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.
      • origin

        public PaymentRequest origin​(String origin)
        > Required for browser-based (`channel` **Web**) 3D Secure 2 transactions.Set this to the origin URL of the page where you are rendering the Drop-in/Component. Do not include subdirectories and a trailing slash.
        Parameters:
        origin - > Required for browser-based (`channel` **Web**) 3D Secure 2 transactions.Set this to the origin URL of the page where you are rendering the Drop-in/Component. Do not include subdirectories and a trailing slash.
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getOrigin

        public String getOrigin()
        > Required for browser-based (`channel` **Web**) 3D Secure 2 transactions.Set this to the origin URL of the page where you are rendering the Drop-in/Component. Do not include subdirectories and a trailing slash.
        Returns:
        origin > Required for browser-based (`channel` **Web**) 3D Secure 2 transactions.Set this to the origin URL of the page where you are rendering the Drop-in/Component. Do not include subdirectories and a trailing slash.
      • setOrigin

        public void setOrigin​(String origin)
        > Required for browser-based (`channel` **Web**) 3D Secure 2 transactions.Set this to the origin URL of the page where you are rendering the Drop-in/Component. Do not include subdirectories and a trailing slash.
        Parameters:
        origin - > Required for browser-based (`channel` **Web**) 3D Secure 2 transactions.Set this to the origin URL of the page where you are rendering the Drop-in/Component. Do not include subdirectories and a trailing slash.
      • paymentMethod

        public PaymentRequest paymentMethod​(CheckoutPaymentMethod paymentMethod)
        paymentMethod
        Parameters:
        paymentMethod -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getPaymentMethod

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

        public void setPaymentMethod​(CheckoutPaymentMethod paymentMethod)
        paymentMethod
        Parameters:
        paymentMethod -
      • paymentValidations

        public PaymentRequest paymentValidations​(PaymentValidations paymentValidations)
        paymentValidations
        Parameters:
        paymentValidations -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getPaymentValidations

        public PaymentValidations getPaymentValidations()
        Get paymentValidations
        Returns:
        paymentValidations
      • setPaymentValidations

        public void setPaymentValidations​(PaymentValidations paymentValidations)
        paymentValidations
        Parameters:
        paymentValidations -
      • platformChargebackLogic

        public PaymentRequest platformChargebackLogic​(PlatformChargebackLogic platformChargebackLogic)
        platformChargebackLogic
        Parameters:
        platformChargebackLogic -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getPlatformChargebackLogic

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

        public void setPlatformChargebackLogic​(PlatformChargebackLogic platformChargebackLogic)
        platformChargebackLogic
        Parameters:
        platformChargebackLogic -
      • recurringExpiry

        public PaymentRequest recurringExpiry​(String recurringExpiry)
        Date after which no further authorisations shall be performed. Only for 3D Secure 2.
        Parameters:
        recurringExpiry - Date after which no further authorisations shall be performed. Only for 3D Secure 2.
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getRecurringExpiry

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

        public void setRecurringExpiry​(String recurringExpiry)
        Date after which no further authorisations shall be performed. Only for 3D Secure 2.
        Parameters:
        recurringExpiry - Date after which no further authorisations shall be performed. Only for 3D Secure 2.
      • recurringFrequency

        public PaymentRequest recurringFrequency​(String recurringFrequency)
        Minimum number of days between authorisations. Only for 3D Secure 2.
        Parameters:
        recurringFrequency - Minimum number of days between authorisations. Only for 3D Secure 2.
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getRecurringFrequency

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

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

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

        public PaymentRequest.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 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.
      • setRecurringProcessingModel

        public void setRecurringProcessingModel​(PaymentRequest.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 - 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.
      • redirectFromIssuerMethod

        public PaymentRequest redirectFromIssuerMethod​(String redirectFromIssuerMethod)
        Specifies the redirect method (GET or POST) when redirecting back from the issuer.
        Parameters:
        redirectFromIssuerMethod - Specifies the redirect method (GET or POST) when redirecting back from the issuer.
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getRedirectFromIssuerMethod

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

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

        public PaymentRequest redirectToIssuerMethod​(String redirectToIssuerMethod)
        Specifies the redirect method (GET or POST) when redirecting to the issuer.
        Parameters:
        redirectToIssuerMethod - Specifies the redirect method (GET or POST) when redirecting to the issuer.
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getRedirectToIssuerMethod

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

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

        public PaymentRequest reference​(String reference)
        The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. To provide multiple references for one transaction, separate the reference values with the hyphen (`-`) character.We strongly recommend that you use a unique value for each transaction. Maximum length: 80 characters.
        Parameters:
        reference - The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. To provide multiple references for one transaction, separate the reference values with the hyphen (`-`) character.We strongly recommend that you use a unique value for each transaction. Maximum length: 80 characters.
        Returns:
        the current PaymentRequest 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. To provide multiple references for one transaction, separate the reference values with the hyphen (`-`) character.We strongly recommend that you use a unique value for each transaction. Maximum length: 80 characters.
        Returns:
        reference The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. To provide multiple references for one transaction, separate the reference values with the hyphen (`-`) character.We strongly recommend that you use a unique value for each transaction. Maximum length: 80 characters.
      • 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. To provide multiple references for one transaction, separate the reference values with the hyphen (`-`) character.We strongly recommend that you use a unique value for each transaction. Maximum length: 80 characters.
        Parameters:
        reference - The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. To provide multiple references for one transaction, separate the reference values with the hyphen (`-`) character.We strongly recommend that you use a unique value for each transaction. Maximum length: 80 characters.
      • returnUrl

        public PaymentRequest returnUrl​(String returnUrl)
        The URL to return to in case of a redirection. The format depends on the channel. * 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.example.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` If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value. We strongly recommend that you use a maximum of 1024 characters. > The URL must not include personally identifiable information (PII), for example name or email address.
        Parameters:
        returnUrl - The URL to return to in case of a redirection. The format depends on the channel. * 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.example.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` If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value. We strongly recommend that you use a maximum of 1024 characters. > The URL must not include personally identifiable information (PII), for example name or email address.
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getReturnUrl

        public String getReturnUrl()
        The URL to return to in case of a redirection. The format depends on the channel. * 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.example.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` If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value. We strongly recommend that you use a maximum of 1024 characters. > The URL must not include personally identifiable information (PII), for example name or email address.
        Returns:
        returnUrl The URL to return to in case of a redirection. The format depends on the channel. * 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.example.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` If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value. We strongly recommend that you use a maximum of 1024 characters. > The URL must not include personally identifiable information (PII), for example name or email address.
      • setReturnUrl

        public void setReturnUrl​(String returnUrl)
        The URL to return to in case of a redirection. The format depends on the channel. * 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.example.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` If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value. We strongly recommend that you use a maximum of 1024 characters. > The URL must not include personally identifiable information (PII), for example name or email address.
        Parameters:
        returnUrl - The URL to return to in case of a redirection. The format depends on the channel. * 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.example.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` If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value. We strongly recommend that you use a maximum of 1024 characters. > The URL must not include personally identifiable information (PII), for example name or email address.
      • riskData

        public PaymentRequest riskData​(RiskData riskData)
        riskData
        Parameters:
        riskData -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getRiskData

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

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

        public PaymentRequest sessionValidity​(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 - 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:
        the current PaymentRequest instance, allowing for method chaining
      • 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 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
      • 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 - 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
      • shopperConversionId

        public PaymentRequest shopperConversionId​(String shopperConversionId)
        A unique ID to [connect the shopper to a single checkout session](https://docs.adyen.com/online-payments/checkout-settings#checkout-shopper-conversion-id) that uses multiple API requests. You can use this to get insights into conversion rates.
        Parameters:
        shopperConversionId - A unique ID to [connect the shopper to a single checkout session](https://docs.adyen.com/online-payments/checkout-settings#checkout-shopper-conversion-id) that uses multiple API requests. You can use this to get insights into conversion rates.
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getShopperConversionId

        public String getShopperConversionId()
        A unique ID to [connect the shopper to a single checkout session](https://docs.adyen.com/online-payments/checkout-settings#checkout-shopper-conversion-id) that uses multiple API requests. You can use this to get insights into conversion rates.
        Returns:
        shopperConversionId A unique ID to [connect the shopper to a single checkout session](https://docs.adyen.com/online-payments/checkout-settings#checkout-shopper-conversion-id) that uses multiple API requests. You can use this to get insights into conversion rates.
      • setShopperConversionId

        public void setShopperConversionId​(String shopperConversionId)
        A unique ID to [connect the shopper to a single checkout session](https://docs.adyen.com/online-payments/checkout-settings#checkout-shopper-conversion-id) that uses multiple API requests. You can use this to get insights into conversion rates.
        Parameters:
        shopperConversionId - A unique ID to [connect the shopper to a single checkout session](https://docs.adyen.com/online-payments/checkout-settings#checkout-shopper-conversion-id) that uses multiple API requests. You can use this to get insights into conversion rates.
      • shopperEmail

        public PaymentRequest shopperEmail​(String shopperEmail)
        The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the `telephoneNumber`.
        Parameters:
        shopperEmail - The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the `telephoneNumber`.
        Returns:
        the current PaymentRequest 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. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the `telephoneNumber`.
        Returns:
        shopperEmail The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the `telephoneNumber`.
      • 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. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the `telephoneNumber`.
        Parameters:
        shopperEmail - The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the `telephoneNumber`.
      • shopperIP

        public PaymentRequest shopperIP​(String shopperIP)
        The shopper's IP address. 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). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. 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 - The shopper's IP address. 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). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. 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:
        the current PaymentRequest instance, allowing for method chaining
      • getShopperIP

        public String getShopperIP()
        The shopper's IP address. 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). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. 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 The shopper's IP address. 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). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. 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).
      • setShopperIP

        public void setShopperIP​(String shopperIP)
        The shopper's IP address. 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). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. 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 - The shopper's IP address. 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). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. 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).
      • shopperInteraction

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

        public PaymentRequest.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 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.
      • setShopperInteraction

        public void setShopperInteraction​(PaymentRequest.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 - 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.
      • shopperLocale

        public PaymentRequest shopperLocale​(String shopperLocale)
        The language for the payment. The value combines the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) language code with the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. For example, **nl-NL**. When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the `locale`.
        Parameters:
        shopperLocale - The language for the payment. The value combines the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) language code with the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. For example, **nl-NL**. When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the `locale`.
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getShopperLocale

        public String getShopperLocale()
        The language for the payment. The value combines the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) language code with the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. For example, **nl-NL**. When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the `locale`.
        Returns:
        shopperLocale The language for the payment. The value combines the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) language code with the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. For example, **nl-NL**. When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the `locale`.
      • setShopperLocale

        public void setShopperLocale​(String shopperLocale)
        The language for the payment. The value combines the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) language code with the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. For example, **nl-NL**. When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the `locale`.
        Parameters:
        shopperLocale - The language for the payment. The value combines the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) language code with the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. For example, **nl-NL**. When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the `locale`.
      • shopperName

        public PaymentRequest shopperName​(ShopperName shopperName)
        shopperName
        Parameters:
        shopperName -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getShopperName

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

        public void setShopperName​(ShopperName shopperName)
        shopperName
        Parameters:
        shopperName -
      • shopperReference

        public PaymentRequest 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 - 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:
        the current PaymentRequest 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 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.
      • 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 - 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.
      • shopperStatement

        public PaymentRequest 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 - 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:
        the current PaymentRequest 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 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 **. , ' _ - ? + * /_**.
      • 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 - 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 **. , ' _ - ? + * /_**.
      • shopperTaxInfo

        public PaymentRequest shopperTaxInfo​(ShopperTaxInfo shopperTaxInfo)
        shopperTaxInfo
        Parameters:
        shopperTaxInfo -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getShopperTaxInfo

        public ShopperTaxInfo getShopperTaxInfo()
        Get shopperTaxInfo
        Returns:
        shopperTaxInfo
      • setShopperTaxInfo

        public void setShopperTaxInfo​(ShopperTaxInfo shopperTaxInfo)
        shopperTaxInfo
        Parameters:
        shopperTaxInfo -
      • socialSecurityNumber

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

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

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

        public PaymentRequest splits​(List<Split> splits)
        An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
        Parameters:
        splits - An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getSplits

        public List<Split> getSplits()
        An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
        Returns:
        splits An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
      • setSplits

        public void setSplits​(List<Split> splits)
        An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
        Parameters:
        splits - An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
      • store

        public PaymentRequest 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 - 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:
        the current PaymentRequest 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 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.
      • 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 - 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.
      • storePaymentMethod

        public PaymentRequest storePaymentMethod​(Boolean storePaymentMethod)
        When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
        Parameters:
        storePaymentMethod - When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getStorePaymentMethod

        public Boolean getStorePaymentMethod()
        When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
        Returns:
        storePaymentMethod When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
      • setStorePaymentMethod

        public void setStorePaymentMethod​(Boolean storePaymentMethod)
        When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
        Parameters:
        storePaymentMethod - When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
      • subMerchants

        public PaymentRequest subMerchants​(List<SubMerchantInfo> subMerchants)
        This field contains additional information on the submerchant, who is onboarded to an acquirer through a payment facilitator or aggregator
        Parameters:
        subMerchants - This field contains additional information on the submerchant, who is onboarded to an acquirer through a payment facilitator or aggregator
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getSubMerchants

        public List<SubMerchantInfo> getSubMerchants()
        This field contains additional information on the submerchant, who is onboarded to an acquirer through a payment facilitator or aggregator
        Returns:
        subMerchants This field contains additional information on the submerchant, who is onboarded to an acquirer through a payment facilitator or aggregator
      • setSubMerchants

        public void setSubMerchants​(List<SubMerchantInfo> subMerchants)
        This field contains additional information on the submerchant, who is onboarded to an acquirer through a payment facilitator or aggregator
        Parameters:
        subMerchants - This field contains additional information on the submerchant, who is onboarded to an acquirer through a payment facilitator or aggregator
      • surcharge

        public PaymentRequest surcharge​(Surcharge surcharge)
        surcharge
        Parameters:
        surcharge -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getSurcharge

        public Surcharge getSurcharge()
        Get surcharge
        Returns:
        surcharge
      • setSurcharge

        public void setSurcharge​(Surcharge surcharge)
        surcharge
        Parameters:
        surcharge -
      • telephoneNumber

        public PaymentRequest telephoneNumber​(String telephoneNumber)
        The shopper's telephone number. The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`.
        Parameters:
        telephoneNumber - The shopper's telephone number. The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`.
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getTelephoneNumber

        public String getTelephoneNumber()
        The shopper's telephone number. The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`.
        Returns:
        telephoneNumber The shopper's telephone number. The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`.
      • setTelephoneNumber

        public void setTelephoneNumber​(String telephoneNumber)
        The shopper's telephone number. The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`.
        Parameters:
        telephoneNumber - The shopper's telephone number. The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`.
      • threeDS2RequestData

        public PaymentRequest threeDS2RequestData​(ThreeDS2RequestFields threeDS2RequestData)
        threeDS2RequestData
        Parameters:
        threeDS2RequestData -
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getThreeDS2RequestData

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

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

        @Deprecated
        public PaymentRequest threeDSAuthenticationOnly​(Boolean threeDSAuthenticationOnly)
        Deprecated.
        since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.
        Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorisation.Default: **false**.
        Parameters:
        threeDSAuthenticationOnly - Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorisation.Default: **false**.
        Returns:
        the current PaymentRequest instance, allowing for method chaining
      • getThreeDSAuthenticationOnly

        @Deprecated
        public Boolean getThreeDSAuthenticationOnly()
        Deprecated.
        since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.
        Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorisation.Default: **false**.
        Returns:
        threeDSAuthenticationOnly Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorisation.Default: **false**.
      • setThreeDSAuthenticationOnly

        @Deprecated
        public void setThreeDSAuthenticationOnly​(Boolean threeDSAuthenticationOnly)
        Deprecated.
        since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.
        Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorisation.Default: **false**.
        Parameters:
        threeDSAuthenticationOnly - Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorisation.Default: **false**.
      • trustedShopper

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

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

        public void setTrustedShopper​(Boolean trustedShopper)
        Set to true if the payment should be routed to a trusted MID.
        Parameters:
        trustedShopper - Set to true if the payment should be routed to a trusted MID.
      • includeNullValues

        public PaymentRequest includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.
      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.
      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
      • equals

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

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

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.
      • fromJson

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

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