List payment options

Payments

Transactions
Buyers
Checkout Sessions
Payment links
Payment options
- GET
  List payment options
- POST
  List payment options with POST
Payouts
Refunds
Sessions
Settlement records

Instruments

Card schemes
Digital wallets
Gift cards
Payment methods
Payment method definitions

Vault

Account updater
Network tokens
Payment service tokens
Vault Forward
Vault Forward endpoints
Vault Forward authentication

Connections

All services
Payment services
Digital wallets
Anti-fraud services
Gift-card services

Dashboard

Flow
Merchant accounts
Reports
Report executions

Errors

GET

payment-options

curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/payment-options \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "type": "payment-option",
      "method": "card",
      "icon_url": "https://cdn.gr4vy.app/card.svg",
      "mode": "card",
      "label": "Pay by Card",
      "can_store_payment_method": true,
      "can_delay_capture": true,
      "context": {
        "gateway": "<string>",
        "gateway_merchant_id": "<string>",
        "merchant_name": "<string>",
        "supported_schemes": [
          "<string>"
        ],
        "approval_ui": {
          "height": "300px",
          "width": "300px"
        },
        "required_fields": {
          "first_name": true,
          "last_name": true,
          "email_address": true,
          "phone_number": true,
          "address": {
            "city": true,
            "country": true,
            "postal_code": true,
            "state": true,
            "house_number_or_name": true,
            "line1": true
          },
          "tax_id": true
        }
      }
    }
  ]
}

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.

Query Parameters

country

string

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

Example:

"US"

currency

string

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

Example:

"USD"

amount

integer

Used by the Flow engine to filter the results based on the transaction amount.

Example:

500

metadata

string

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.

Example:

"{\"restricted_items\": \"True\"}"

locale

string

default:

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.

Example:

"en-US"

Response

200

application/json

Returns a list of available payment options for the given query parameters.

A list of payment options.

items

object[]

An available payment option for a locale.

items.type

enum<string>

payment-option.

Available options:

payment-option

Example:

"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,

efecty,

eps,

everydaypay,

gcash,

gem,

gemds,

gift-card,

giropay,

givingblock,

gocardless,

googlepay,

googlepay_pan_only,

gopay,

grabpay,

id,

ideal,

kakaopay,

kcp,

klarna,

latitude,

latitudeds,

laybuy,

linepay,

linkaja,

maybankqrpay,

mercadopago,

multibanco,

multipago,

netbanking,

network-token,

oney_3x,

oney_4x,

oney_6x,

oney_10x,

oney_12x,

ovo,

oxxo,

payid,

paymaya,

paypal,

paypalpaylater,

payto,

venmo,

pix,

pse,

rabbitlinepay,

razorpay,

scalapay,

sepa,

shopeepay,

singteldash,

smartpay,

sofort,

spei,

stripedd,

thaiqr,

touchngo,

truemoney,

trustly,

trustlyeurope,

upi,

vipps,

waave,

webpay,

wechat,

zippay

Example:

"card"

items.icon_url

string | null

An icon to display for the payment option.

Example:

"https://cdn.gr4vy.app/card.svg"

items.mode

enum<string>

The mode to use with this payment option.

Available options:

card,

redirect,

applepay,

googlepay,

click-to-pay,

checkout-session

Example:

"card"

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.

Example:

"Pay by Card"

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.

Was this page helpful?

Expire payment link List payment options with POST

curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/payment-options \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "type": "payment-option",
      "method": "card",
      "icon_url": "https://cdn.gr4vy.app/card.svg",
      "mode": "card",
      "label": "Pay by Card",
      "can_store_payment_method": true,
      "can_delay_capture": true,
      "context": {
        "gateway": "<string>",
        "gateway_merchant_id": "<string>",
        "merchant_name": "<string>",
        "supported_schemes": [
          "<string>"
        ],
        "approval_ui": {
          "height": "300px",
          "width": "300px"
        },
        "required_fields": {
          "first_name": true,
          "last_name": true,
          "email_address": true,
          "phone_number": true,
          "address": {
            "city": true,
            "country": true,
            "postal_code": true,
            "state": true,
            "house_number_or_name": true,
            "line1": true
          },
          "tax_id": true
        }
      }
    }
  ]
}