Ledger
The Ledger is the double-entry bookkeeping ledger that is the sole, official source of truth for every balance on the platform. No balance is ever changed directly — every change is the consequence of a Ledger Entry.
Why double-entry
A Ledger Account is the sub-account that accumulates entries for a specific holder (a business Account, the Treasury, or the platform's revenue). Every Ledger Entry is an individual, immutable record of a debit or credit, always part of a balanced entry — the sum of all entries for an operation is always zero. Once consolidated, a Ledger Entry is never edited or removed; corrections use new compensating entries.
This discipline — never writing a balance value directly, always through a traceable entry — is what makes every balance auditable end to end.
Example
Reserving 100 USDT for a Transaction generates two entries that sum to zero: -100 USDT in the
source Account's available balance, +100 USDT in the same Account's reserved balance. No value
is "moved" — two accounting records are created, always together.
Beyond Available/Pending/Reserved
Two more entry natures exist specifically for Payout: Payable (an amount a beneficiary is
owed but hasn't been paid yet — read via getPayableSummary, an economic obligation, never an
on-chain balance) and Delivered (cumulative history of what was actually paid out — under
Self-Custody, this is what a beneficiary's leg confirming produces, not a credit to Available;
see Transaction, Settlement, Split, and Refund). Never confuse
either with Available — a beneficiary can have a real, growing Delivered total while their
Available balance in this Ledger stays exactly 0, because the money already left the platform's
custody entirely.
Routes
- Get an Account's entries:
GET /v1/accounts/{accountId}/ledger-entries - Get balance (derived from entries):
get-account-balance