Package com.adyen.model.checkout

Class PaymentMethodsRequest

  • public class PaymentMethodsRequest
extends Object
    PaymentMethodsRequest

    • Constructor Detail

      • PaymentMethodsRequest

        public PaymentMethodsRequest()

    • Method Detail

      • additionalData

        public PaymentMethodsRequest 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 PaymentMethodsRequest 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.

      • allowedPaymentMethods

        public PaymentMethodsRequest allowedPaymentMethods​(List<String> allowedPaymentMethods)
        List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`
        Parameters:
        allowedPaymentMethods - List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`
        Returns:
        the current PaymentMethodsRequest instance, allowing for method chaining

      • getAllowedPaymentMethods

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

      • setAllowedPaymentMethods

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

      • amount

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

      • getAmount

        public Amount getAmount()
        Get amount
        Returns:
        amount

      • setAmount

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

      • blockedPaymentMethods

        public PaymentMethodsRequest blockedPaymentMethods​(List<String> blockedPaymentMethods)
        List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`
        Parameters:
        blockedPaymentMethods - List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`
        Returns:
        the current PaymentMethodsRequest instance, allowing for method chaining

      • getBlockedPaymentMethods

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

      • setBlockedPaymentMethods

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

      • browserInfo

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

      • getBrowserInfo

        public BrowserInfo getBrowserInfo()
        Get browserInfo
        Returns:
        browserInfo

      • setBrowserInfo

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

      • channel

        public PaymentMethodsRequest channel​(PaymentMethodsRequest.ChannelEnum channel)
        The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values: * iOS * Android * Web
        Parameters:
        channel - The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values: * iOS * Android * Web
        Returns:
        the current PaymentMethodsRequest instance, allowing for method chaining

      • getChannel

        public PaymentMethodsRequest.ChannelEnum getChannel()
        The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values: * iOS * Android * Web
        Returns:
        channel The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values: * iOS * Android * Web

      • setChannel

        public void setChannel​(PaymentMethodsRequest.ChannelEnum channel)
        The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values: * iOS * Android * Web
        Parameters:
        channel - The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values: * iOS * Android * Web

      • countryCode

        public PaymentMethodsRequest countryCode​(String countryCode)
        The shopper's country code.
        Parameters:
        countryCode - The shopper's country code.
        Returns:
        the current PaymentMethodsRequest instance, allowing for method chaining

      • getCountryCode

        public String getCountryCode()
        The shopper's country code.
        Returns:
        countryCode The shopper's country code.

      • setCountryCode

        public void setCountryCode​(String countryCode)
        The shopper's country code.
        Parameters:
        countryCode - The shopper's country code.

      • merchantAccount

        public PaymentMethodsRequest 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 PaymentMethodsRequest 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.

      • shopperConversionId

        public PaymentMethodsRequest shopperConversionId​(String shopperConversionId)
        A unique ID that can be used to associate `/paymentMethods` and `/payments` requests with the same shopper transaction, offering insights into conversion rates.
        Parameters:
        shopperConversionId - A unique ID that can be used to associate `/paymentMethods` and `/payments` requests with the same shopper transaction, offering insights into conversion rates.
        Returns:
        the current PaymentMethodsRequest instance, allowing for method chaining

      • getShopperConversionId

        public String getShopperConversionId()
        A unique ID that can be used to associate `/paymentMethods` and `/payments` requests with the same shopper transaction, offering insights into conversion rates.
        Returns:
        shopperConversionId A unique ID that can be used to associate `/paymentMethods` and `/payments` requests with the same shopper transaction, offering insights into conversion rates.

      • setShopperConversionId

        public void setShopperConversionId​(String shopperConversionId)
        A unique ID that can be used to associate `/paymentMethods` and `/payments` requests with the same shopper transaction, offering insights into conversion rates.
        Parameters:
        shopperConversionId - A unique ID that can be used to associate `/paymentMethods` and `/payments` requests with the same shopper transaction, offering insights into conversion rates.

      • shopperEmail

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

      • getShopperEmail

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

      • setShopperEmail

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

      • shopperIP

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

      • getShopperIP

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

      • setShopperIP

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

      • shopperLocale

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

      • getShopperLocale

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

      • setShopperLocale

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

      • shopperReference

        public PaymentMethodsRequest shopperReference​(String shopperReference)
        Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
        Parameters:
        shopperReference - Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
        Returns:
        the current PaymentMethodsRequest 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. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
        Returns:
        shopperReference Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as 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. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
        Parameters:
        shopperReference - Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.

      • splitCardFundingSources

        public PaymentMethodsRequest splitCardFundingSources​(Boolean splitCardFundingSources)
        Boolean value indicating whether the card payment method should be split into separate debit and credit options.
        Parameters:
        splitCardFundingSources - Boolean value indicating whether the card payment method should be split into separate debit and credit options.
        Returns:
        the current PaymentMethodsRequest instance, allowing for method chaining

      • getSplitCardFundingSources

        public Boolean getSplitCardFundingSources()
        Boolean value indicating whether the card payment method should be split into separate debit and credit options.
        Returns:
        splitCardFundingSources Boolean value indicating whether the card payment method should be split into separate debit and credit options.

      • setSplitCardFundingSources

        public void setSplitCardFundingSources​(Boolean splitCardFundingSources)
        Boolean value indicating whether the card payment method should be split into separate debit and credit options.
        Parameters:
        splitCardFundingSources - Boolean value indicating whether the card payment method should be split into separate debit and credit options.

      • store

        public PaymentMethodsRequest 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 PaymentMethodsRequest 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.

      • storeFiltrationMode

        public PaymentMethodsRequest storeFiltrationMode​(PaymentMethodsRequest.StoreFiltrationModeEnum storeFiltrationMode)
        Specifies how payment methods should be filtered based on the 'store' parameter: - 'exclusive': Only payment methods belonging to the specified 'store' are returned. - 'inclusive': Payment methods from the 'store' and those not associated with any other store are returned.
        Parameters:
        storeFiltrationMode - Specifies how payment methods should be filtered based on the 'store' parameter: - 'exclusive': Only payment methods belonging to the specified 'store' are returned. - 'inclusive': Payment methods from the 'store' and those not associated with any other store are returned.
        Returns:
        the current PaymentMethodsRequest instance, allowing for method chaining

      • getStoreFiltrationMode

        public PaymentMethodsRequest.StoreFiltrationModeEnum getStoreFiltrationMode()
        Specifies how payment methods should be filtered based on the 'store' parameter: - 'exclusive': Only payment methods belonging to the specified 'store' are returned. - 'inclusive': Payment methods from the 'store' and those not associated with any other store are returned.
        Returns:
        storeFiltrationMode Specifies how payment methods should be filtered based on the 'store' parameter: - 'exclusive': Only payment methods belonging to the specified 'store' are returned. - 'inclusive': Payment methods from the 'store' and those not associated with any other store are returned.

      • setStoreFiltrationMode

        public void setStoreFiltrationMode​(PaymentMethodsRequest.StoreFiltrationModeEnum storeFiltrationMode)
        Specifies how payment methods should be filtered based on the 'store' parameter: - 'exclusive': Only payment methods belonging to the specified 'store' are returned. - 'inclusive': Payment methods from the 'store' and those not associated with any other store are returned.
        Parameters:
        storeFiltrationMode - Specifies how payment methods should be filtered based on the 'store' parameter: - 'exclusive': Only payment methods belonging to the specified 'store' are returned. - 'inclusive': Payment methods from the 'store' and those not associated with any other store are returned.

      • telephoneNumber

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

      • getTelephoneNumber

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

      • setTelephoneNumber

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

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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