Cash Balance Transfers

Create a cash balance transfer

Create an internal cash balance transfer between two account groups belonging to the same user and tenant. The cash leaves the source account group and arrives at the target account group as a single operation, with no external bank transfer. Only settled cash denominated in the same currency (EUR) can be transferred. Both account groups must be of the same type, and the type must be one of PERSONAL, CHILD, or BUSINESS.

post/payments/cash_balance_transfers

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/payments/cash_balance_transfers
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: cash_balance_transfers:admin)

Headers

idempotency-keystring uuid required
Example:ccb07f42-4104-44ad-8e1f-c660bb7b269c

A UUID to be used as an idempotency key. This prevents a duplicate request from being replayed. https://docs.upvest.co/documentation/concepts/api_concepts/idempotency

Request body

source_account_group_idstring uuid required

Universally Unique Identifier (UUID) of the account group.

target_account_group_idstring uuid required

Universally Unique Identifier (UUID) of the account group.

amountstring required

A positive cash amount, as a decimal string with up to two decimal places.

currency'EUR' | 'GBP' required

Alphabetic three-letter ISO 4217 currency code.

  • EUR — Euro.
  • GBP — Pound Sterling.

Response

Cash balance transfer

idstring uuid required

Cash balance transfer unique identifier

created_atstring date-time required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

updated_atstring date-time required

Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC

source_account_group_idstring uuid required

Universally Unique Identifier (UUID) of the account group.

target_account_group_idstring uuid required

Universally Unique Identifier (UUID) of the account group.

amountstring required

A positive cash amount, as a decimal string with up to two decimal places.

currency'EUR' | 'GBP' required

Alphabetic three-letter ISO 4217 currency code.

  • EUR — Euro.
  • GBP — Pound Sterling.
status'ISSUED' | 'CONFIRMED' | 'CANCELLED' required

Status of the cash balance transfer.

  • ISSUED - Transfer has been created and the cash movement is in progress.
  • CONFIRMED - Cash was successfully moved from the source to the target account group.
  • CANCELLED - Transfer was cancelled and no cash was moved.
cancellation_reasonstring nullable

Reason the transfer was cancelled. Present only when status is CANCELLED, otherwise null.

Changes

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