List payment options with POST
Returns a list of available payment method options for the combination of amount, currency, country, metadata and list of cart items.
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.
Body
A request to get list of payment options.
The monetary amount to create an authorization for, in the smallest
currency unit for the given currency, for example 1299 cents to create
an authorization for $12.99.
If the intent is set to capture, an amount greater than zero must
be supplied.
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.
A supported ISO-4217 currency code.
For redirect requests, this value must match the one specified for
currency in payment_method.
Filters the results to only the items which support this country code. A country is formatted as 2-letter ISO country code.
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 array of cart items that represents the line items of a transaction.
Response
A list of payment options.
Was this page helpful?