Liquidations

Create account liquidation request

Initiates a full liquidation of an investment account, placing sell orders for all held positions and converting the proceeds to cash.

Exactly one of user_id or business_id must be provided in the request body.

See the Liquidations guide (TOL / BYOL) for implementation details.

post/accounts/{account_id}/liquidations

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/accounts/{account_id}/liquidations
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: account_liquidations: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

OR

Response

Account liquidation object

idstring uuid required

Universally Unique Identifier (UUID) of an account liquidation.

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

Unique identifier of the user, as a UUID.

business_idstring uuid

Unique identifier for the business.

account_idstring uuid required

Universally Unique Identifier (UUID) of the account.

cash_amountstring required

A positive decimal amount, as a string.

currency'EUR' | 'GBP' required

Alphabetic three-letter ISO 4217 currency code.

  • EUR — Euro.
  • GBP — Pound sterling.
status'NEW' | 'PROCESSING' | 'FILLED' | 'CANCELLED' | 'SETTLED' required

Execution status of the account liquidation.

  • NEW — The liquidation has been created and awaits processing.
  • PROCESSING — The liquidation orders are being executed.
  • FILLED — All liquidation orders have been fully executed.
  • CANCELLED — The liquidation was cancelled before completion.
  • SETTLED — The liquidation proceeds have settled as cash.
fee_collection_idstring uuid required

The unique identifier of the fee collection, as a UUID.

Changes

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