Cash Balances

Retrieve an account group's cash balance for particular ISO currency code

Returns the account group's cash balance for the given currency.

See the Cash balances guide (TOL / BYOL) for implementation details.

get/account_groups/{account_group_id}/payments/cash_balances/{currency}

Request

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

Response

Response

account_group_idstring uuid required

Universally Unique Identifier (UUID) of the account group.

currency'EUR' | 'GBP' | 'USD' required

Alphabetic three-letter ISO 4217 currency code.

  • EUR — Euro.
  • GBP — Pound Sterling.
  • USD — The United States dollar.
balancestring required
locked_for_tradingstring required

A positive decimal amount, as a string.

pending_settlementstring required

A positive decimal amount, as a string.

available_for_withdrawalstring required
available_for_tradingstring required

Changes

No recorded changes to this operation across all 25 revisions of this API.