---
title: "Retrieve an account group's cash balances"
method: GET
path: "/account_groups/{account_group_id}/payments/cash_balances"
tags: ["Cash Balances"]
---

# Retrieve an account group's cash balances

`GET /account_groups/{account_group_id}/payments/cash_balances`

## Request

- Base URL: `https://sandbox.upvest.co`
- URL: `https://sandbox.upvest.co/account_groups/{account_group_id}/payments/cash_balances`
- Auth: OAuth 2 (client credentials, token URL `https://sandbox.upvest.co/auth/token`, scopes: `positions:read`)

Returns the list of cash balances held by the account group.

See the Cash balances guide ([TOL](https://docs.upvest.co/products/tol/guides/payments/cash_balances/cash_balances_intro) / [BYOL](https://docs.upvest.co/products/byol/guides/payments/cash_balances/cash_balances_intro)) for how `balance`, `locked_for_trading`, `pending_settlement`, `available_for_withdrawal`, and `available_for_trading` relate to each other.

## Response `200`

Response

- object: List of the account group's cash balances.
  - `meta` object, required: Offset/limit pagination metadata for a list response. Contains the `offset` and `limit` applied to the request, the `count` of resources returned in this page, and the `total_count` of matching resources.
    - `offset` integer, required: Amount of resource to offset in the response.
    - `limit` integer, required: Total limit of the response.
    - `count` integer, required: Count of the resources returned in the response.
    - `total_count` integer, required: Total count of all the resources.
    - `sort` string: The field that the list is sorted by.
    - `order` 'ASC' | 'DESC': The ordering applied to the list. * ASC — Ascending order. * DESC — Descending order.
  - `data` object[], required: The list of cash balance objects, one per currency the account group holds.
    - `account_group_id` string, uuid, required: Universally Unique Identifier (UUID) of the account group.
    - `currency` 'EUR' | 'GBP' | 'USD', required: Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR — Euro. * GBP — Pound Sterling. * USD — The United States dollar.
    - `balance` string, required
    - `locked_for_trading` string, required: A positive decimal amount, as a string.
    - `pending_settlement` string, required: A positive decimal amount, as a string.
    - `available_for_withdrawal` string, required
    - `available_for_trading` string, required

## Other responses

- `401`: Unauthorized. The caller has not been authenticated.
- `403`: Forbidden. The caller has been authenticated but is not allowed to take the requested action.
- `404`: Not Found. The requested resource could not be found.
- `406`: Not Found. The requested resource could not be found.
- `429`: Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
- `500`: Internal Server Error. The service encountered an unexpected error.
- `503`: Service Unavailable. The service handling for this request cannot be reached at this time.
- `504`: Gateway Timeout. The service gateway has reached its internal timeout.

---

[API](https://skmtc.dev/upvest/apis/upvest-investment-api.md) · [All operations](https://skmtc.dev/upvest/apis/upvest-investment-api/llms.txt) · [OpenAPI document](https://skmtc.dev/upvest/apis/upvest-investment-api/revisions/ca69534b631d?raw)