Core concepts
Balances & ledger
Balances are current state. Ledger credits are append-only history. Use both: balances for availability, ledger for auditability.
Balances
GET
/v1/balancesList balances by assetGET
/v1/balances/{asset}Get a single asset balanceUse balances for spend/withdraw decisions and dashboard totals. Balance rows are environment-scoped and asset-scoped. Each row exposes three buckets:
available_balance— funds you can withdraw or pay out now.pending_balance— incoming credits not yet available (e.g. sweep in flight).reserved_balance— held for withdrawals already in progress; already deducted from available.
Ledger credits
GET
/v1/ledger/creditsList ledger credit entriesLedger credits provide the immutable timeline behind balance movement. They are ideal for:
- Finance reconciliation exports.
- Tracing payment settlement into available balance.
- Dispute and support investigations.
Simple reconciliation pattern
1) Fetch /v1/balances for current position
2) Fetch /v1/ledger/credits for movement history
3) Join by payment/payout references in your system
4) Use webhooks for near-real-time updatesIf your app settles to multiple assets, keep each asset key as a first-class identifier in your own schema instead of normalizing away chain/token details.
Reference endpoints: /business/reference/balances and /business/reference/ledger.