# Retrieve balances for each sub-account (currency account) in an entity.
Authorizations:
bearer
HTTP: bearer #
HTTP Authorization Scheme: bearer
Bearer format: JWT
path Parameters #
idrequired string Example: ent_w4jelhppmfiufdnatam37wrfc4The ID of the entity.
query Parameters #
query stringThe query to apply to limit the currency accounts. Example: currency:EUR withCurrencyAccountId boolean Default: false Example: withCurrencyAccountId=falseSpecifies if the response should include the sub-account ID that corresponds to each set of balances.
Authorizationrequired string
Responses #
200 Balances retrieved successfully.
Array
currency required stringThe currency of the sub-account. available required numberThe available balance. pending required numberThe pending balance. reserved required numberThe reserved balance. total required numberThe total balance. entity_id required stringThe entity ID. currency_account_id stringThe sub-account ID (currency account ID).
400 Query format not supported
Response Schema: application/json #
request_id required stringThe unique request identifier. error_type required stringThe error type. error_codes required Array of stringsThe error codes.
401 Unauthorized
404 Entity not found
Response Schema: application/json #
request_id required stringThe unique request identifier. error_type required stringThe error type. error_codes required Array of stringsThe error codes.
422 Invalid data was sent
Response Schema: application/json #
request_id required stringThe unique request identifier. error_type required stringThe error type. error_codes required Array of stringsThe error codes.
EN 
ZH 
