POST /paymentMethods
Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to /payments).
Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the /paymentMethods response and update it once a week.
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. Minimum length: 3 characters.
|
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 |
shopperLocale |
String | No |
The combination of a language code and a country code to specify the language to be used in the payment. |
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: |
allowedPaymentMethods[] |
Array | No |
List of payment methods to be presented to the shopper. To refer to payment methods, use their payment method type. Example: |
order |
Object | No |
The order information required for partial payments. |
order.pspReference |
String | Yes |
The |
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:
Possible values:
|
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 |
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:
Possible values:
|
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.