POST
/
checkout
/
sessions
curl --request POST \
  --url https://api.{gr4vy_id}.gr4vy.app/checkout/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "cart_items": [
    {
      "categories": [
        "<string>"
      ],
      "discount_amount": 123,
      "external_identifier": "item-789123",
      "image_url": "https://example.com/images/items/gopro.png",
      "name": "GoPro HERO9 Camcorder",
      "product_type": "physical",
      "product_url": "https://example.com/items/gopro",
      "quantity": 1,
      "sku": "sku-789123",
      "tax_amount": 123,
      "unit_amount": 37999
    }
  ],
  "metadata": {
    "key": "value"
  }
}'
{
  "cart_items": [
    {
      "categories": [
        "<string>"
      ],
      "discount_amount": 123,
      "external_identifier": "item-789123",
      "image_url": "https://example.com/images/items/gopro.png",
      "name": "GoPro HERO9 Camcorder",
      "product_type": "physical",
      "product_url": "https://example.com/items/gopro",
      "quantity": 1,
      "sku": "sku-789123",
      "tax_amount": 123,
      "unit_amount": 37999
    }
  ],
  "expires_at": "2022-01-01T00:00:00+00:00",
  "id": "8d3fe99b-1422-42e6-bbb3-932d95ae5f79",
  "metadata": {
    "key": "value"
  },
  "payment_method": {
    "details": {
      "bin": "411111",
      "card_country": "US",
      "card_type": "credit"
    },
    "fingerprint": "20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17",
    "id": "<string>",
    "label": "4242",
    "method": "card",
    "scheme": "visa",
    "type": "payment_method"
  },
  "type": "checkout-session"
}

This endpoint requires the checkout-sessions.write scope.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
cart_items
object[] | null

An array of cart items that represents the line items of a transaction.

metadata
object | null

Any additional information about the transaction that you would like to store as key-value pairs. This data is passed to payment service providers that support it.

Response

201 - application/json
cart_items
object[] | null

An array of cart items that represents the line items of a transaction.

expires_at
string

The date and time when the Checkout Session will expire. By default this will be set to 1 hour from the date of creation.

id
string

The ID of the Checkout Session.

metadata
object | null

Any additional information about the transaction that you would like to store as key-value pairs. This data is passed to payment service providers that support it.

payment_method
object | null

Details about the payment method for card type only.

type
enum<string>

checkout-session.

Available options:
checkout-session