Skip to main content
Use this endpoint to retrieve the balance of a single ledger account. By default, calling this endpoint returns the account’s current balance — computed from all posted journal entries up to the moment the request is received. If you need to audit or reconcile historical state, pass the optional asOf query parameter with an ISO 8601 datetime to receive the balance as it stood at that exact point in time.

​
Endpoint

​
Authorization

Requires an API key with the ACCOUNTS_READ scope. Pass your key in the Authorization header using the Bearer scheme.

​
Parameters

​
string (UUID)
required
The unique identifier of the account whose balance you want to retrieve. Must be a valid UUID corresponding to an account that exists in your tenant.
​
string (ISO 8601 datetime)
An optional point-in-time datetime. When supplied, the API returns the balance computed from all entries whose createdAt is on or before this timestamp. When omitted, the API returns the current balance using all posted entries.Example: 2024-05-31T23:59:59Z

​
Request examples

Current balance
Point-in-time balance
Remember to URL-encode the asOf value when constructing the query string manually. The colons (:) in an ISO 8601 datetime must be encoded as %3A.

​
Response

​
string (UUID)
required
The unique identifier of the account, echoed back from the request.
​
string
required
The ISO 4217 currency code of the account (e.g. USD, BRL).
​
number
required
The computed balance as a decimal number. The value reflects the net effect of all posted journal entries up to (and including) the asOf timestamp, or up to the present moment if asOf was omitted.
​
string
required
DEBIT or CREDIT, matching the account’s type — tells you which side amount represents.
​
string (ISO 8601)
required
The server timestamp at which the balance was computed. This is not an echo of the asOf you passed — it always reflects when the calculation ran.
​
array
required
Net on-chain balance per stablecoin token, summed across all chains the token was posted on. Each item is { token, amount }, where token is one of the supported stablecoin tokens (e.g. USDC, USDT, BRZ, PYUSD) and amount is the net balance for that token. Results are sorted by token name. An account with only fiat entries returns [].

​
Response example

Point-in-time balance queries are fully consistent — the ledger is append-only, so a historical balance will always return the same result regardless of when you request it.
amount is the fiat balance in the account’s declared currency — it only sums fiat entries. On-chain (stablecoin) entries posted to the same account are reported separately in onChainBalances and are never combined with amount: a token amount and a fiat amount are not fungible units.

​
Error codes