---
title: "Trigger a virtual cash increase"
method: POST
path: "/virtual_cash_balances/increases"
tags: ["Virtual Cash Balances"]
---

# Trigger a virtual cash increase

`POST /virtual_cash_balances/increases`

## Request

- Base URL: `https://sandbox.upvest.co`
- URL: `https://sandbox.upvest.co/virtual_cash_balances/increases`
- Auth: OAuth 2 (client credentials, token URL `https://sandbox.upvest.co/auth/token`, scopes: `virtual_cash_balances:admin`)

Increases an account group's virtual cash balance, making the specified `amount` available for trading before the corresponding real cash has settled.

Requires the `Idempotency-Key` header to prevent duplicate increases.

See the Virtual cash guide ([TOL](https://docs.upvest.co/products/tol/guides/virtual_cash/implementing_virtual_cash) / [BYOL](https://docs.upvest.co/products/byol/guides/virtual_cash/implementing_virtual_cash)) for supported use cases.

## Headers

- `idempotency-key` string, uuid, required

## Request body

- object: Request to increase an account group's virtual cash balance by a given amount and currency.
  - `account_group_id` string, uuid, required: Universally Unique Identifier (UUID) of the account group.
  - `amount` string, required: A positive cash amount, as a decimal string with up to two decimal places.
  - `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.

## Response `202`

Virtual Cash Balances Increase

- object: A request to increase an account group's virtual cash balance, and its current processing status.
  - `id` string, uuid, required: The unique identifier of a virtual cash increase or decrease operation.
  - `created_at` string, date-time, required: Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
  - `updated_at` string, date-time, required: Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
  - `account_group_id` string, uuid, required: Universally Unique Identifier (UUID) of the account group.
  - `amount` string, required: A positive cash amount, as a decimal string with up to two decimal places.
  - `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.
  - `status` 'ISSUED' | 'CONFIRMED' | 'CANCELLED', required: Status of the virtual cash * ISSUED - Virtual cash increase is created. * CONFIRMED - Virtual cash increase was successfully processed. * CANCELLED - Virtual cash increase was cancelled.

## Other responses

- `400`: Bad Request. The incoming request had a malformed parameter/object.
- `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 Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
- `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)