Open specs
JSON Schemas
Everything Arettic sends you has a published shape: receipts, execute requests and answers, webhook events and pass rules. Validate against them, generate types from them, or build your own receipt checker. JSON Schema 2020-12, licensed CC-BY-4.0.
| Schema | Version | Describes |
|---|---|---|
| receipt.json Receipt | 1.0.0 | A purchase's receipt: every item attempt, its check, charge and refund. |
| execute-request.json Execute request | 1.0.0 | The body of POST /v1/execute. |
| execute-response.json Execute response | 1.0.0 | Every successful answer of POST /v1/execute: item, batch, job, approval, test mode. |
| webhook-event.json Webhook event | 1.0.0 | The body of every webhook delivery, with the data of each event type. |
| pass-rules.json Pass rules | 1.0.0 | The pass rule of every task type, as served by GET /v1/task-types and /v1/formula. |
The API serves the same files at https://api.arettic.com/schemas/{name}.json, with an index at GET https://api.arettic.com/schemas. Fields can be added without notice; removing or renaming one changes the version. How receipts are hashed is on Receipts.