---
title: "Retrieve entity balances"
method: GET
path: "/balances/{id}"
tags: ["Balances"]
---

# Retrieve entity balances

`GET /balances/{id}`

## Request

- Base URL: `https://balances.checkout.com`
- URL: `https://balances.checkout.com/balances/{id}`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `string` scopes: `balances`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/balances/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Query parameters

- `withCurrencyAccountId` boolean
- `balancesAt` string, date-time

## Response `200`

Balances retrieved successfully.

- BalancesResponse: A list of balances for each currency account returned from the request.
  - `data` CurrencyAccountBalance[]: The list of requested balances.
    - `currency_account_id` string: The unique identifier of the currency account (sub-account). Returned only when the request is made with `withCurrencyAccountId=true`.
    - `descriptor` string: A descriptor for the currency account.
    - `holding_currency` string: The holding currency of the currency account (the three character ISO 4217 code).
    - `balances_as_of` string, date-time: The UTC datetime reflecting when the balance values were fetched. If the request includes a `balancesAt` query parameter, this matches that value; otherwise, it is the time the request was processed.
    - `balances` Balance: The respective balance values.
      - `pending` number: The total incoming funds that will be added to the Available balance once cleared.
      - `available` number: The funds that are available for processing.
      - `payable` number: The funds reserved from the Available balance for outgoing transactions that are yet to clear.
      - `collateral` number: The funds held by Checkout.com to cover potential liabilities and risk events associated with your payment processing.
      - `operational` number: The funds held for processing Payouts and Issuing payments when the Available balance is insufficient.
      - `collateral_breakdown` object: A breakdown of the funds held in the `collateral` balance.
        - `fixed_reserve` number, required: The portion of the `collateral` balance held as a fixed reserve.
        - `rolling_reserve` number, required: The portion of the `collateral` balance held as a rolling reserve.

## Other responses

- `400`: Invalid query parameter — for example, an unsupported `query` filter value, a non-boolean `withCurrencyAccountId`, or a malformed `balancesAt` value.
- `401`: Unauthorized
- `404`: Entity not found
- `422`: Invalid data was sent

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)