Payment options
List payment options
Account updater
Buyers - Payment methods
Payment methods
Payment methods - Payment service tokens
Payment methods - Network tokens
Buyers - Gift cards
Buyers - Shipping details
Card scheme definitions
Digital wallets - Setup
Digital wallets - Sessions
Transactions
Refunds
Payment options
Payment service definitions
Payment services
Audit logs
Checkout sessions
Merchant accounts
Payment options
List payment options
List the payment options available at checkout. filtering by country, currency, and additional fields passed to Flow rules.
POST
/
payment-options
curl --request POST \
--url https://api.{id}.gr4vy.app/payment-options \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"metadata": {
"cohort": "a"
},
"country": "US",
"currency": "USD",
"amount": 1299,
"locale": "en",
"cart_items": [
{
"name": "GoPro HD",
"quantity": 2,
"unit_amount": 1299,
"discount_amount": 0,
"tax_amount": 0,
"external_identifier": "goprohd",
"sku": "GPHD1078",
"product_url": "https://example.com/catalog/go-pro-hd",
"image_url": "https://example.com/images/go-pro-hd.jpg",
"categories": [
"camera",
"travel",
"gear"
],
"product_type": "physical",
"seller_country": "US"
}
]
}'
{
"items": [
{
"type": "payment-option",
"method": "<string>",
"icon_url": "<string>",
"mode": "card",
"label": "<string>",
"can_store_payment_method": true,
"can_delay_capture": true,
"context": {
"merchant_name": "<string>",
"supported_schemes": [
"<string>"
]
}
}
]
}
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.
Examples:
"default"
Body
application/json
Response
200
application/json
Successful Response
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.{id}.gr4vy.app/payment-options \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"metadata": {
"cohort": "a"
},
"country": "US",
"currency": "USD",
"amount": 1299,
"locale": "en",
"cart_items": [
{
"name": "GoPro HD",
"quantity": 2,
"unit_amount": 1299,
"discount_amount": 0,
"tax_amount": 0,
"external_identifier": "goprohd",
"sku": "GPHD1078",
"product_url": "https://example.com/catalog/go-pro-hd",
"image_url": "https://example.com/images/go-pro-hd.jpg",
"categories": [
"camera",
"travel",
"gear"
],
"product_type": "physical",
"seller_country": "US"
}
]
}'
{
"items": [
{
"type": "payment-option",
"method": "<string>",
"icon_url": "<string>",
"mode": "card",
"label": "<string>",
"can_store_payment_method": true,
"can_delay_capture": true,
"context": {
"merchant_name": "<string>",
"supported_schemes": [
"<string>"
]
}
}
]
}