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
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.
A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
This field contains additional data, which may be required for a particular payment request.
additionalData object consists of entries, each of which includes the key and value.
List of payment methods to be presented to the shopper. To refer to payment methods, use their payment method type.
List of payment methods to be hidden from the shopper. To refer to payment methods, use their payment method type.
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:
The shopper's country code.
The merchant account identifier, with which you want to process the transaction.
The order information required for partial payments.
The combination of a language code and a country code to specify the language to be used in the payment.
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.
Boolean value indicating whether the card payment method should be split into separate debit and credit options.
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
200 - OK
The request has succeeded.Show more
400 - Bad Request
A problem reading or understanding the request.Show more
401 - Unauthorized
Authentication required.Show more
403 - Forbidden
Insufficient permissions to process the request.Show more
422 - Unprocessable Entity
A request validation error.Show more
500 - Internal Server Error
The server could not process the request.Show more