List balances

GET 
/v1/balances

List the balances of all accounts your bank has registered: one entry per (account, asset) pair. Only your bank's own accounts are included; interbank holdings of other banks' assets are reported by GET /v1/exposures.

Each entry reports total, locked, reserved and available; see the Balance schema for exact definitions (normally total = available + locked + reserved). Response-level meta gives the ledger cut every entry on this page was read at and whether the read is current (see PositionReadMetadata). meta is omitted when the page is empty. Different pages may be read at different cuts.

Required scope: connector:balances:list.

Filters are exact, case-sensitive matches combined with AND; a value that matches nothing returns an empty data array.

Order. Ascending by external_account_id, then by the account's root asset.

Request

Responses

200

One page of balances for the calling bank's accounts.

400

The request is malformed: invalid JSON syntax, an invalid path or query parameter, a missing required header such as Idempotency-Key, or a single field that fails its own format rule. Fix the request before retrying; retrying it unchanged fails again.

401

The bearer token is missing, malformed, expired, signed by an unknown key, or was not issued by the platform IAM for the Lyriq Connector. Obtain a new token and retry. See the Authentication section.

403

The token is valid but may not perform this request: it lacks the required scope, has no bank membership, needs an x-dan-bank-id header to choose between several memberships, names a bank in x-dan-bank-id it has no membership for, or the caller's bank is suspended or terminated. A new token with the same configuration fails the same way. See the Authentication section.

429

The request was refused because a rate limit was reached (code RATE_LIMITED). No Retry-After header is sent; retry with exponential backoff.

503

The request could not be served right now. Either the network is not fully operational (OUTBOUND_HALTED or READ_ONLY: mutations are refused while read endpoints keep working; OPERATIONAL_STATE_UNKNOWN: the state could not be determined), or a platform dependency is temporarily unavailable. No Retry-After header is sent; retry later with backoff. When retrying a mutation, reuse the same Idempotency-Key and body.