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

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 | null

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.