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

# Retrieve an account group's cash balance

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

## Request

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

> **Deprecated.**

**Deprecated.** Use `GET /account_groups/{account_group_id}/payments/cash_balances/{currency}` instead.

Returns the account group's cash balance.

## Response `200`

Response

- object: The account group's cash balance for a single currency, broken down into the total amount and how much of it is locked for trading, pending settlement, available for withdrawal, or available for trading.
  - `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)