Create a checkout | Cheddar Docs

curl -X POST https://api.cheddar.biz/v1/checkouts \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "items": [
    {
      "sku": "ABC123",
      "priceUsd": "49.99",
      "quantity": 2
    }
  ],
  "idempotencyKey": "checkout-20240615-xyz789"
}'

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "organizationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "idempotencyKey": "checkout-20240615-xyz789",
  "priceUsdSnapshot": "99.98",
  "acceptedNetworksTokensSnapshot": [
    {}
  ],
  "matchToleranceBpsSnapshot": 50,
  "refundGasPayerSnapshot": "COMPANY",
  "expiresAt": "2024-07-15T09:30:00Z",
  "hostedUrl": "https://checkout.cheddar.biz/checkout/d290f1ee-6c54-4b01-90e6-d701748f0851",
  "successUrl": "https://merchant.example.com/success",
  "cancelUrl": "https://merchant.example.com/cancel",
  "status": "OPEN",
  "metadata": {},
  "lineItems": [
    {
      "id": "e7b8f1a2-3c4d-4f5a-9b6c-123456789abc",
      "productId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "quantity": 2,
      "unitPriceUsdSnapshot": "49.99",
      "lineTotalUsdSnapshot": "99.98",
      "productSnapshot": {},
      "sortOrder": 1
    }
  ],
  "createdAt": "2024-06-15T09:30:00Z",
  "updatedAt": "2024-06-15T09:30:00Z"
}

Idempotent on idempotencyKey — a replay returns 200 with the existing checkout.

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

itemslist of objectsRequired

idempotencyKeystringRequired1-255 characters

expiresInSecondsintegerOptional3600-604800

successUrlstringOptionalformat: "uri"

cancelUrlstringOptionalformat: "uri"

metadatamap from strings to anyOptional

Response

Existing checkout (idempotent replay)

idstringformat: "uuid"

organizationIdstringformat: "uuid"

idempotencyKeystring

priceUsdSnapshotstring

Decimal string, 2dp

acceptedNetworksTokensSnapshotlist of maps from strings to any

matchToleranceBpsSnapshotinteger

refundGasPayerSnapshotenum

expiresAtdatetime

hostedUrlstring

Shareable checkout link

successUrlstring or null

cancelUrlstring or null

statusenum

metadatamap from strings to any or null

lineItemslist of objects

createdAtdatetime

updatedAtdatetime

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error