Sign in
Payments

Get a list of available payment methods

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.

post/paymentMethods

Headers

Idempotency-Keystring

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

Request body

additionalDataobject

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.

allowedPaymentMethodsstring[]

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

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

blockedPaymentMethodsstring[]

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

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

channel'iOS' | 'Android' | 'Web'

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
countryCodestring

The shopper's country code.

merchantAccountstring required

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

shopperConversionIdstring

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

shopperLocalestring

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

shopperReferencestring

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.

splitCardFundingSourcesboolean

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

storestring

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.

storeFiltrationMode'exclusive' | 'inclusive' | 'skipFilter'

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.

Response

OK - the request has succeeded.

Changes