List checkouts

GET

/checkouts

GET

/v1/checkouts

curl https://api.cheddar.biz/v1/checkouts \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json"

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "organizationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "idempotencyKey": "a1b2c3d4e5f67890",
      "priceUsdSnapshot": "149.99",
      "acceptedNetworksTokensSnapshot": [
        {
          "network": "ethereum",
          "token": "USDC"
        }
      ],
      "matchToleranceBpsSnapshot": 50,
      "refundGasPayerSnapshot": "COMPANY",
      "expiresAt": "2024-01-15T09:30:00Z",
      "hostedUrl": "https://checkout.cheddar.biz/checkout/3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "successUrl": "https://merchant.example.com/success",
      "cancelUrl": "https://merchant.example.com/cancel",
      "status": "OPEN",
      "metadata": {
        "customerId": "cust_123456",
        "orderReference": "ORD-987654"
      },
      "lineItems": [
        {
          "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
          "productId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "quantity": 2,
          "unitPriceUsdSnapshot": "74.99",
          "lineTotalUsdSnapshot": "149.98",
          "productSnapshot": {
            "description": "Noise-cancelling over-ear headphones",
            "name": "Wireless Headphones",
            "sku": "WH-1000XM4"
          },
          "sortOrder": 1
        }
      ],
      "createdAt": "2024-01-10T14:22:00Z",
      "updatedAt": "2024-01-12T16:45:00Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "9f8c7d6e-5b4a-3c2d-1e0f-123456789abc"
}

Authentication

x-api-keystring

API Key authentication via header

Query parameters

statusenumOptional

product_idstringOptionalformat: "uuid"

limitintegerOptional1-100

cursorstringOptionalformat: "uuid"

Response

Checkouts

itemslist of objects

hasMoreboolean

nextCursorstring or nullformat: "uuid"

Errors

401

Unauthorized Error