POST /paymentMethods

Default value: "application/json"

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

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.

The shopper's browser information.

For 3D Secure, the full object is required for web integrations. For mobile app integrations, include the userAgent and acceptHeader fields to indicate that your integration can support a redirect in case a payment is routed to 3D Secure 2 redirect.

Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.

Default value: true

The total width of the shopper's device screen in pixels.

Time difference between UTC time and the shopper's browser local time, in minutes.

The total height of the shopper's device screen in pixels.

The accept header value of the shopper's browser.

The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's screen.colorDepth property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.

Boolean value indicating if the shopper's browser is able to execute Java.

The navigator.language value of the shopper's browser (as defined in IETF BCP 47).

The user agent value of the shopper's browser.

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.

The merchant account identifier, with which you want to process the transaction.

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.

The combination of a language code and a country code to specify the language to be used in the payment.

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.

The shopper's country code.

List of payment methods to be hidden from the shopper. To refer to payment methods, use their payment method type.

Example: "blockedPaymentMethods":["ideal","applepay"]

List of payment methods to be presented to the shopper. To refer to payment methods, use their payment method type.

Example: "allowedPaymentMethods":["ideal","applepay"]

The order information required for partial payments.

The pspReference that belongs to the order.

The encrypted order data.

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

Valid values:

• "iOS"
• "Web"
• "Android"

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.

The amount information for the transaction (in minor units). For BIN or card verification requests, set amount to 0 (zero).

The amount of the transaction, in minor units.

The three-character ISO currency code.

A unique ID that can be used to associate /paymentMethods and /payments requests with the same shopper transaction, offering insights into conversion rates.

Boolean value indicating whether the card payment method should be split into separate debit and credit options.

Default value: false

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.

Valid values:

• "inclusive"
• "exclusive"
• "skipFilter"

Required for Adyen for Platforms integrations if you are a platform model. This is your reference (on balance platform) or the storeReference (in the classic integration) for the ecommerce or point-of-sale store that is processing the payment.