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

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.

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.

currency
string

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

amount
integer

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

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.

locale
string
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.

Response

200 - application/json
items
object[]