List payment options with POST

This endpoint requires the payment-options.read or embed scope.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A request to get list of payment options.

amount

integer | null

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.

locale

string | null

default: en

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.

currency

string | null

A supported ISO-4217 currency code.

For redirect requests, this value must match the one specified for currency in payment_method.

country

string | null

Filters the results to only the items which support this country code. A country is formatted as 2-letter ISO country code.

metadata

object | null

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.

cart_items

object[] | null

An array of cart items that represents the line items of a transaction.

cart_items.name

string

required

The name of the cart item. The value you set for this property may be truncated if the maximum length accepted by a payment service provider is less than 255 characters.

Maximum length: 255

cart_items.quantity

integer

required

The quantity of this item in the cart. This value cannot be negative or zero.

Required range: 1 < x < 99999999

cart_items.unit_amount

integer

required

The amount for an individual item represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 USD cents represents $12.99. The amount sent through to the payment processor as unitary amount will be calculated to include the discount and tax values sent as part of this cart item.

Required range: 0 < x < 99999999

cart_items.discount_amount

integer | null

default: 0

The amount discounted for this item represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 USD cents represents $12.99.

Please note that this amount is for the total of the cart item and not for an individual item. For example, if the quantity is 5, this value should be the total discount amount for 5 of the cart item.

You might see unexpected failed transactions if the discount_amount can not be equally divided by the quantity value. This is due to the fact that some payment services require this amount to be specified per unit.

In this situation we recommend splitting this item into separate items, each with their own specific discount.

Required range: 0 < x < 99999999

cart_items.tax_amount

integer | null

default: 0

The tax amount for this item represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 USD cents represents $12.99.

Please not that this amount is for the total of the cart item and not for an individual item. For example, if the quantity is 5, this value should be the total tax amount for 5 of the cart item.

You might see unexpected failed transactions if the tax_amount can not be equally divided by the quantity value. This is due to the fact that some payment services require this amount to be specified per unit.

In this situation we recommend splitting this item into separate items, each with their own specific tax amount.

Required range: 0 < x < 99999999

cart_items.external_identifier

string | null

An external identifier for the cart item. This can be set to any value and is not sent to the payment service.

Maximum length: 200

cart_items.sku

string | null

The SKU for the item.

Maximum length: 200

cart_items.product_url

string | null

The product URL for the item.

Maximum length: 2083

cart_items.image_url

string | null

The URL for the image of the item.

Maximum length: 2083

cart_items.categories

string[] | null

A list of strings containing product categories for the item. Max length per item: 50.

cart_items.product_type

enum<string> | null

The product type of the cart item.

Available options:

physical,

discount,

shipping_fee,

sales_tax,

digital,

gift_card,

store_credit,

surcharge

Response

200 - application/json

A list of payment options.

items

object[]

items.type

enum<string>

payment-option.

Available options:

payment-option

items.method

enum<string>

The type of payment method that is available.

Available options:

afterpay,

alipay,

alipayhk,

applepay,

bacs,

bancontact,

banked,

becs,

bitpay,

boleto,

boost,

card,

cashapp,

chaseorbital,

checkout-session,

clearpay,

click-to-pay,

dana,

dcb,

dlocal,

ebanx,

eps,

everydaypay,

gcash,

giropay,

givingblock,

gocardless,

googlepay,

googlepay_pan_only,

gopay,

grabpay,

id,

ideal,

kakaopay,

kcp,

klarna,

laybuy,

linepay,

linkaja,

maybankqrpay,

multibanco,

multipago,

network-token,

oney_3x,

oney_4x,

oney_6x,

oney_10x,

oney_12x,

ovo,

oxxo,

payid,

paymaya,

paypal,

paypalpaylater,

payto,

venmo,

pix,

rabbitlinepay,

razorpay,

scalapay,

sepa,

shopeepay,

singteldash,

smartpay,

sofort,

spei,

stripedd,

thaiqr,

touchngo,

truemoney,

trustly,

trustlyeurope,

vipps,

waave,

wechat,

zippay

items.icon_url

string | null

An icon to display for the payment option.

items.mode

enum<string>

The mode to use with this payment option.

Available options:

card,

redirect,

applepay,

googlepay,

click-to-pay,

checkout-session

items.label

string

A label that describes this payment option. This label is returned in the language defined by the locale query parameter. The label can be used to display a list of payment options to the buyer in their language.

items.can_store_payment_method

boolean

A flag to indicate if storing the payment method is supported.

items.can_delay_capture

boolean

A flag to indicate if delayed capture is supported.

items.context

object

Additional context specific to the payment option. This is currently only returned for Apple Pay and Google Pay.

items.context.gateway

string

Gateway used for Google Pay payments.

items.context.gateway_merchant_id

string

Gateway merchant identifier used for Google Pay payments.

items.context.merchant_name

string

Display name of the merchant as registered with the digital wallet provider.

items.context.supported_schemes

string[]

Card schemes supported by the digital wallet provider.

items.context.approval_ui

object

Configuration for the approval interface that should be shown to the buyer.

items.context.required_fields

object

The fields that are required to process a transaction for this payment option.

Payments

Instruments

Vault

Connections

Dashboard

Errors

List payment options with POST

Authorizations

Body

Response