Cash Balance Transfers

Retrieve cash balance transfer

Retrieve a cash balance transfer by its ID.

get/payments/cash_balance_transfers/{cash_balance_transfer_id}

Request

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

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.