List payment options

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

Authorizations

Authorization

string

header

required

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

Headers

x-gr4vy-merchant-account-id

string

The ID of the merchant account to use for this request.

Body

application/json

metadata

Metadata · object

The metadata to used to evaluate checkout rules, which will help determine the right payment options to display.

Show child attributes

metadata.{key}

string

Example:

{ "cohort": "a" }

country

string | null

The country code used to evaluate checkout rules, and which are used to help determine the right payment options to display.

Example:

"US"

currency

string | null

The currency code used to evaluate checkout rules, and which are used to help determine the right payment options to display.

Example:

"USD"

amount

integer | null

The amount used to evaluate checkout rules, and which are used to help determine the right payment options to display.

Example:

1299

locale

string

default:en

The locale used to determine the labels for each payment option.

Required string length: 1 - 50

cart_items

CartItem · object[] | null

The cart items used to evaluate checkout rules, and which are used to help determine the right payment options to display.

Show child attributes

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.

Required string length: 1 - 255

cart_items.quantity

integer

required

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

Required range: 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.

Required range: 0 <= x <= 99999999

Example:

0

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.

Required range: 0 <= x <= 99999999

Example:

0

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.

Required string length: 1 - 200

Example:

"goprohd"

cart_items.sku

string | null

The SKU or product code for the item.

Required string length: 1 - 200

Example:

"GPHD1078"

cart_items.upc

string | null

The UPC for the item.

Required string length: 1 - 50

Example:

"012345678905"

cart_items.product_url

string | null

The product URL for the item.

Example:

"https://example.com/catalog/go-pro-hd"

cart_items.image_url

string | null

The URL for the image of the item.

Example:

"https://example.com/images/go-pro-hd.jpg"

cart_items.categories

string[] | null

A list of strings containing product categories for the item.

Required string length: 1 - 50

Example:

["camera", "travel", "gear"]

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

Example:

"physical"

cart_items.seller_country

string | null

The seller country of the cart item.

Example:

"US"

cart_items.tax_exempt

boolean | null

Whether the item is exempt of tax.

Example:

false

cart_items.unit_of_measure

string | null

The unit of measure or the unit of measure code.

Required string length: 1 - 50

Example:

"feet"

cart_items.commodity_code

string | null

Item commodity code. Generally a UNSPSC code.

Required string length: 1 - 50

Example:

"43211503"

cart_items.description

string | null

Brief item description.

Required string length: 1 - 255

Example:

"A brief description of an interesting item."

cart_items.duty_amount

integer | null

Item import or export duties represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 cents to create an authorization for $12.99

Required range: 0 <= x <= 99999999

Example:

1299

cart_items.shipping_amount

integer | null

Freight/shipping amount represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 cents to create an authorization for $12.99

Required range: 0 <= x <= 99999999

Example:

1299

Response

Successful Response

items

PaymentOption · object[]

required

A list of items returned for this request.

Show child attributes

items.method

string

required

items.mode

enum<string>

required

Available options:

card,

redirect,

applepay,

googlepay,

checkout-session,

click-to-pay,

gift-card,

bank

items.can_store_payment_method

boolean

required

items.can_delay_capture

boolean

required

items.type

string

default:payment-option

Allowed value: "payment-option"

items.icon_url

string | null

Required string length: 1 - 1500

items.label

string | null

Required string length: 1 - 200

items.context

WalletPaymentOptionContext · object

WalletPaymentOptionContext
GooglePayPaymentOptionContext
PaymentOptionContext

Show child attributes

items.context.merchant_name

string

required

items.context.supported_schemes

string[]

required

Introduction

Transactions

Buyers

Checkout Sessions

Payment links

Payment options

Refunds

Sessions

Instruments

Vault

Connections

Errors

Other

List payment options

Authorizations

Headers

Body

Response