List payment options
Returns a list of available payment method options for the combination of amount, currency, country and metadata.
If the amount is zero, payment options which do not support zero amounts, will be omitted in the response.
Checkout flow rules are used to limit these result.
This endpoint requires the payment-options.read or embed scope.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filters the results to only the items which support this country code. A country is formatted as 2-letter ISO country code.
Filters the results to only the items which support this currency code. A currency is formatted as 3-letter ISO currency code.
Used by the Flow engine to filter the results based on the transaction amount.
Used by the Flow engine to filter available options based on various client-defined parameters. If present, this must be a string representing a valid JSON dictionary.
An ISO 639-1 Language Code and optional ISO 3166 Country Code. This locale determines the language for the labels returned for every payment option.
Response
A list of payment options.
Was this page helpful?