Products
GET /v1/products/{gtin}
Is this line in scope, at what deposit, from when. Bulk and delta endpoints for nightly sync.
Docs
Versioned REST. OpenAPI. No surprises.
Six surfaces, one integration. Written for the engineer who has to make an existing till estate behave by 2027.
API overview.
Transactions
POST /v1/transactions
Deposits charged and refunded at the till. Idempotent, queued when offline, replayed on reconnect.
Vouchers
POST /v1/vouchers/redeem
Validate and consume a return voucher exactly once. Offline pre-check with a signed local rule set.
Return points
POST /v1/returns
Manual counts and machine sessions, with the evidence a claim needs attached.
Claims
GET /v1/claims/{period}
What was claimed, what the scheme paid, and every line that did not match.
Webhooks
POST your endpoint
Voucher rejected, claim settled, product scope changed. Signed, retried, replayable.
How we handle the unknowns.
The UK voucher and claims specifications are not fully published yet. Every scheme-facing field sits behind an abstraction in our API, so when the specification lands you change nothing.
- Identifiers — GS1 standards throughout, so vouchers and products carry identifiers your scanners already read.
- Versioning — every endpoint is pinned. Breaking changes ship as a new version with both live side by side.
- Offline — transactions and voucher checks are designed to work with no connection and settle later, once.
- Test data — the sandbox ships a UK product set and a voucher generator, so you can prove behaviour before 1 October 2027.
Identifier standards: GS1 UK. Scheme documentation: Exchange for Change.
Request a key.
Sandbox keys are issued by email while the specification settles, so we can tell you when something changes. Full reference documentation ships with the key.
Thank you.
Your key is on its way by email, with the full API reference. Usually within one working day.