List payment options
List the payment options available at checkout. filtering by country, currency, and additional fields passed to Flow rules.
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.
Headers
The ID of the merchant account to use for this request.
"default"
Body
The metadata to used to evaluate checkout rules, which will help determine the right payment options to display.
{ "cohort": "a" }
The country code used to evaluate checkout rules, and which are used to help determine the right payment options to display.
"DE"
"GB"
"US"
The currency code used to evaluate checkout rules, and which are used to help determine the right payment options to display.
"EUR"
"GBP"
"USD"
The amount used to evaluate checkout rules, and which are used to help determine the right payment options to display.
1299
The locale used to determine the labels for each payment option.
1 - 50
"en"
The cart items used to evaluate checkout rules, and which are used to help determine the right payment options to display.
Response
Successful Response
A list of items returned for this request.