The API returns JSON snapshots of checks, including line items, modifiers, discounts, comps, and payments. It uses OAuth client credentials for access and cursor-based polling for updates.
Guides
- Quickstart — Get credentials, authenticate, and read checks.
- Syncing checks — Import history, save cursors, and handle updates.
- Sandbox — Test with synthetic data from two locations.
Endpoints
| Request | Purpose |
|---|---|
POST /oauth/token |
Get an access token. |
GET /v1/locations |
List authorized locations. |
GET /v1/locations/{location_id}/checks |
Get check snapshots. |
See the API reference for parameters and response fields, or download the OpenAPI spec.
Access
Email support@chompypos.com for sandbox or production credentials. Include your company name and a short description of your integration.