Skip to content

Record what a party spent (API key, POS)

post/api/v1/reservations/{id}/checks

A till reports a check's total, in the venue's currency's minor units. Never line items: itemised sales stay in the POS. This records spend against the visit and charges nothing.

Idempotent by externalId, the till's own check number: sending it again updates the same check (reopened, a tip added, voided), so no Idempotency-Key is needed and a visit is never counted twice; a refund is the same check resent with its new total. Check numbers are kept apart per partner (the key's partner label, or the key itself), so two tills can both use 1001. A check number already on another reservation is refused. Any other field, line items included, is ignored and never stored. The guest's lifetime figure is lifetimeSpend on GET /api/v1/clients. 201 for a new check, 200 for an update.

Authorization

bearerApiKey reservations:write
AuthorizationBearer <token>

Build with a test key (sk_test_...): it works only in your API sandbox and never emails or texts anyone. Scopes, errors and limits.

In: header

Scope: reservations:write

Path Parameters

id*string

Reservation id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/reservations/string/checks" \  -H "Content-Type: application/json" \  -d '{    "externalId": "string",    "totalCents": 0  }'
{  "data": {}}