POST /paymentMethods

Retrieves the list of available payment methods for the transaction, based on the transaction information like amount, country, and currency.

Servers

https://checkout-test.adyen.com/v71

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Idempotency-Key`	String	No	A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request body fields

Name	Type	Required	Description
`shopperReference`	String	No	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.
`browserInfo`	Object	No	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.
`browserInfo.javaScriptEnabled`	Boolean	No	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
`browserInfo.screenWidth`	Integer	Yes	The total width of the shopper's device screen in pixels.
`browserInfo.timeZoneOffset`	Integer	Yes	Time difference between UTC time and the shopper's browser local time, in minutes.
`browserInfo.screenHeight`	Integer	Yes	The total height of the shopper's device screen in pixels.
`browserInfo.acceptHeader`	String	Yes	The accept header value of the shopper's browser.
`browserInfo.colorDepth`	Integer	Yes	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.
`browserInfo.javaEnabled`	Boolean	Yes	Boolean value indicating if the shopper's browser is able to execute Java.
`browserInfo.language`	String	Yes	The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).
`browserInfo.userAgent`	String	Yes	The user agent value of the shopper's browser.
`shopperIP`	String	No	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.
`merchantAccount`	String	Yes	The merchant account identifier, with which you want to process the transaction.
`additionalData`	Object	No	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.
`shopperLocale`	String	No	The combination of a language code and a country code to specify the language to be used in the payment.
`telephoneNumber`	String	No	The shopper's telephone number.
`countryCode`	String	No	The shopper's country code.
`blockedPaymentMethods[]`	Array	No	List of payment methods to be hidden from the shopper. To refer to payment methods, use their payment method type. Example: `"blockedPaymentMethods":["ideal","applepay"]`
`allowedPaymentMethods[]`	Array	No	List of payment methods to be presented to the shopper. To refer to payment methods, use their payment method type. Example: `"allowedPaymentMethods":["ideal","applepay"]`
`order`	Object	No	The order information required for partial payments.
`order.pspReference`	String	Yes	The `pspReference` that belongs to the order.
`order.orderData`	String	Yes	The encrypted order data.
`channel`	String	No	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 Possible values: `"iOS"` `"Web"` `"Android"`
`shopperEmail`	String	No	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.
`amount`	Object	No	The amount information for the transaction (in minor units). For BIN or card verification requests, set amount to 0 (zero).
`amount.value`	Integer	Yes	The amount of the transaction, in minor units.
`amount.currency`	String	Yes	The three-character ISO currency code.
`shopperConversionId`	String	No	A unique ID that can be used to associate `/paymentMethods` and `/payments` requests with the same shopper transaction, offering insights into conversion rates.
`splitCardFundingSources`	Boolean	No	Boolean value indicating whether the card payment method should be split into separate debit and credit options. Default value: false
`storeFiltrationMode`	String	No	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. Possible values: `"inclusive"` `"exclusive"` `"skipFilter"`
`store`	String	No	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.