API reference
Full API reference
318 endpoints across 22 product areas, generated from the OpenAPI specification. Every endpoint documents its required RBAC action, parameters, request body and responses, including typed variants (ADTs).
Bruno and Insomnia can import either the OpenAPI spec or the Postman collection.
Read once and you can predict any endpoint you have not used: paths, the six operations, pagination, errors, money and the tagged-union rule.
Digital cards are issued against a loan and drawn down as they are used. A card is issued, may be
What the platform knows about a phone number or an email address that has been sent a one-time code:
Turning a business into an organisation customer, in two steps.
What a marketplace earns on payments its sub-merchants take, the revenue share, credited to a merchant
A merchant is a business that takes payments on the platform. Merchants are onboarded, activated
A payment source is a stored means of payment held against a customer, a card, a bank account
A transaction is a payment taken from a customer on behalf of a merchant. It is authorised, then
A filter catalogue says which filters one list offers this caller: each filter's name and label, the operators it
An order is the commerce record, what was bought, for how much, by whom. A transaction is the
A loan is a revolving facility a borrower draws against and repays. Its balances, the limit, what
A payout is money the platform sent to a merchant's bank account. Payouts are raised on the merchant's
An FX rate set is a set of exchange rates an enterprise maintains. It is addressed by its
A webhook subscription delivers platform events to an endpoint you control.
A payment token authorises one payment of a stated amount. Issue one from your checkout, then
Reference data is what the platform keeps so it can validate what you send: the Australian and New
A system ledger is one of the platform's own books. Read them to reconcile: every movement the platform
An enterprise is the party that holds the platform contract. Marketplaces, merchants, loan
An organisation is a business's legal record: its registration, its registered office, how it is
A queue is a stream the platform drains internally. Webhook delivery is the first; the list is discovered
A report dataset is something a dashboard can ask questions of: the dimensions it can be grouped and
A merchant invoice is what the platform charged a merchant for a period, and what has been paid against
A simulation makes the platform do something its scheduler would normally do, so a test does not have