Sign in

v2

latestOpenAPI 3.0.3Apache 2.02026-08-0715707.5 MB
Liquidations

Create account liquidation request

Create account liquidation request

post/accounts/{account_id}/liquidations

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

OR

Response

Account liquidation object

idstring uuid required
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

user_idstring uuid

User unique identifier.

business_idstring uuid

Unique identifier for the business.

account_idstring uuid required

Account unique identifier.

cash_amountstring required
currency'EUR' | 'GBP' required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
  • GBP - British Pound
status'NEW' | 'PROCESSING' | 'FILLED' | 'CANCELLED' | 'SETTLED' required

Execution status of the Account liquidation.

  • NEW -
  • PROCESSING -
  • FILLED -
  • CANCELLED -
  • SETTLED -
fee_collection_idstring uuid required

Fee collection unique identifier.