Skip to main content
POST
C#
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.

Example:

"default"

Body

application/json
metadata
Metadata · object | null

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

Example:
country
string | null

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

Pattern: ^[A-Z]{2}$
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.

Pattern: ^[A-Z]{3}$
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
Example:

"en"

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.

Response

Successful Response

items
PaymentOption · object[]
required

A list of items returned for this request.