Sign in
latestOpenAPI 3.0.3Apache 2.02026-08-1915707.5 MB

2c6bc192bc09

Virtual Cash Balances

Trigger a virtual cash decrease

Trigger a virtual cash decrease

post/virtual_cash_balances/decreases

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

account_group_idstring uuid required

Account group unique identifier.

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

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
  • GBP - Pound Sterling
  • USD - The United States dollar

Response

Virtual Cash Balances Decrease

idstring uuid required

Virtual cash 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

account_group_idstring uuid required

Account group unique identifier.

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

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
  • GBP - Pound Sterling
  • USD - The United States dollar
status'ISSUED' | 'CONFIRMED' | 'QUEUED' | 'CANCELLED' required

Status of the virtual cash

  • ISSUED - Virtual cash decrease is created.
  • CONFIRMED - Virtual cash decrease was successfully processed.
  • QUEUED - Virtual cash decrease was queued.
  • CANCELLED - Virtual cash decrease was cancelled.