Documentation
The whole reference is 7 pages and about 58 minutes. Every request and response below is real seed data: real store ids, real landmarks, real minor-unit amounts.
Reference
Find what you need
Start here
Commerce
- Orders end to endThe order machine, the three legs that drive it, addresses that a courier can actually find, and cash with change.12 min
- Catalogue syncPush offers, prices and availability from a POS, and read back exactly which offer was refused and why.7 min
- Events and ticketsCreate events and tiers at scale, issue tickets, and read the check-in manifest the door will actually use.6 min
Platform
- Markets, money and addressesSix markets, six currencies, nine rails and three address styles — and why none of them come from the device locale.9 min
- Webhooks and the event envelopeOne envelope for every event, a signature you can verify in six lines, ordering per aggregate and a retry schedule you can plan around.10 min
If you read one page
Create an order
The quickstart takes you from an empty terminal to an order moving through Luanda, with cash and change.
- Quickstart
- Key, first order, first event
- Orders end to end
- States, addresses, cash, cancellation
Before you charge anyone
Money and currencies
Six markets, six currencies, three different ways of writing a decimal separator. Read this once and never format an amount by hand again.
- Markets and money
- Minor units, cifrão, XOF, cells
- Catalogue
- Prices, modifiers, availability
How you hear about it
Webhooks
One envelope, one signature scheme, one retry schedule. Nothing in the API needs polling.
- Webhooks
- Envelope, signature, retries
- Event catalogue
- Every event, grouped by context