The Balance object

Represents the merchant's internal ledger balance for a single asset. Aeses does not give merchants a custodial wallet — instead, every deposit credits the corresponding asset balance, every withdrawal debits it, and swap operations move value between balances without any on-chain transaction.

Balances are denormalized snapshots updated by the ledger. They are eventually consistent with the ledger journal — for transaction-by-transaction accounting, query the ledger entries directly.

Attributes

stringOptional

Always "balance".

stringOptional

The asset code. Examples: BTC, ETH, USDC, USDT, SOL, TRX, MATIC.

stringOptional

Amount available for withdrawal or swap, as a decimal string. Excludes funds locked by pending withdrawals.

stringOptional

Funds received but not yet confirmed on-chain. Becomes available once the confirmation threshold is met.

stringOptional

Funds reserved by an in-flight withdrawal. Subtracted from available until the withdrawal completes or fails.

stringOptional

available + pending + locked. Provided for convenience; always equal to the sum of the other three fields.

integerOptional

Unix timestamp (seconds) of the most recent ledger entry that touched this balance.

Endpoints

The Balance object
{
"object": "balance",
"asset": "USDC",
"available": "1250.75",
"pending": "99.50",
"locked": "150.00",
"total": "1500.25",
"updated_at": 1731600125
}