Documentation

Guides for the Ledger API

Four guides, in reading order. Every request and response in them was captured from a running instance. None of it is illustrative.

Before you start

You will need a key. Tenants and keys are provisioned personally. Request access and we mint your first one. Request access.
Every response here is real. Each request and reply in these guides was captured from a running instance, never written by hand.
Amounts are sent as text. "100.00", never a JSON number. Fields ending in _minor are whole minor units.
Every write carries a key. Derive it from your own record. A retry after a timeout then replays the answer and never moves value twice.

Guide 1

From nothing to a posted, balanced transaction. Asset types, accounts, holds and the retry protocol, every response captured from a running instance.

Guide 2

Give each of your own clients an isolated ledger. Production and sandbox tenants, keys issued and revoked, suspend and restore, all through the API.

Guide 3

Every endpoint, field and error code of the Ledger API, with the retryable ones marked, plus the machine-readable OpenAPI and llms.txt contracts.

Guide 4

How credentials work in the Ledger API. One key shape, four roles, expiry and revocation enforced by the ledger, and what to do when a key leaks.