CHcheckout
Balances

Retrieve entity balances

Use this endpoint to retrieve balances for each sub-account in an entity. <br/>Note: The sub-account is referred to as currency account in the API.

get/balances/{id}

Request

Query parameters

withCurrencyAccountIdboolean

Specifies if the response should include the sub-account ID that corresponds to each set of balances.

balancesAtstring date-time
Example:2026-05-06T13:59:59.9999999+00:00

A UTC datetime to retrieve historical balances at a specific point in time, in the format yyyy-MM-ddTHH:mm:ssZ (e.g. 2026-05-06T13:59:59.9999999+00:00). Must be in the past. If omitted, the response returns live balances.

Response

Balances retrieved successfully.

Example response

{
  "data": [
    {
      "currency_account_id": "ca_g5y7d6jo4e2urgforcbf2ey5jm",
      "descriptor": "Revenue Account 1",
      "holding_currency": "EUR",
      "balances_as_of": "2026-05-06T13:59:59.9999999+00:00",
      "balances": {
        "pending": 23000,
        "available": 50000,
        "payable": 2700,
        "collateral": 6000,
        "operational": 7000,
        "collateral_breakdown": {
          "fixed_reserve": 4000,
          "rolling_reserve": 2000
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.