Sign in

v2

latestOpenAPI 3.0.3Apache 2.02026-08-0715707.5 MB
Account Transfers

Create account transfer

Create account transfer

post/account_transfers

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

direction'INCOMING' | 'OUTGOING' required

Direction of the securities transfer

  • INCOMING - Securities transfer is incoming to the user.
  • OUTGOING - Securities transfer is outgoing from the user.
user_idstring uuid required

User unique identifier.

account_idstring uuid required

Account unique identifier.

transfer_type'NO_OWNER_CHANGE' required

Type of the securities transfer

  • NO_OWNER_CHANGE - No change of ownership.
settlement_referencestring required

Unique identifier of the account transfer set by API consumers. Useful for API consumers to build special logic on top of it. NOTE: This reference will be set and be common to all securities transfers

trade_datestring date

Optional forecast date when the trade takes place. If provided, usually T+1 is sufficient. Depending on the market this means valid working days. Date in YYYY-MM-DD format. NOTE: Each individual transfer can differ based on market needs.

settlement_datestring date

Optional forecast date when the settlement takes place. If provided, usually T+2 is sufficient or trade_date + 1. Depending on the market this means valid working days. Date in YYYY-MM-DD format. *NOTE: Each individual transfer can differ based on market needs.

order_datestring date

Optional date when the transfer request was received from the end user. If omitted, Upvest defaults order_date to the transfer's created_at timestamp. The regulatory deadline runs from this date. Date in YYYY-MM-DD format.

Response

Account Transfer created

idstring uuid required

Account transfer request 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

direction'INCOMING' | 'OUTGOING' required

Direction of the account transfer

  • INCOMING - account transfer is incoming to the user.
  • OUTGOING - account transfer is outgoing from the user.
status'NEW' | 'PROCESSING' | 'SETTLED' | 'PARTIALLY_SETTLED' | 'CANCELLED' required

Status of the account transfer

  • NEW - account transfer is created but not started processing.
  • PROCESSING - account transfer is in processing.
  • SETTLED - account transfer was successfully settled.
  • PARTIALLY_SETTLED - account transfer was partially settled, while some instrument got cancelled.
  • CANCELLED - account transfer was cancelled.
transfer_type'NO_OWNER_CHANGE' required

Type of the account transfer

  • NO_OWNER_CHANGE - No change of ownership.
user_idstring uuid required

User unique identifier.

account_idstring uuid required

Account unique identifier.

settlement_referencestring required

Unique identifier of the account transfer set by API consumers. Useful for API consumers to build special logic on top of it. NOTE: This reference will be set and be common to all securities transfers.

trade_datestring date

The forecast date when the trade takes place. Date in YYYY-MM-DD format. NOTE: This date mirrors the preliminary date if given in request as input, each single transfer can have their own date according to market needs.

settlement_datestring date

The forecast date when the settlement takes place. Date in YYYY-MM-DD format. NOTE: This date mirrors the preliminary date if given in request as input, each single transfer can have their own date according to market needs.

order_datestring date

Date the transfer request was received from the end user. The regulatory deadline runs from this date. Date in YYYY-MM-DD format.

delay_reason'COUNTERPARTY_NOT_INSTRUCTING' | 'COUNTERPARTY_NOT_RESPONDING' | 'COUNTERPARTY_DOES_NOT_AGREE_TO_DELIVERY_DETAILS' | 'COUNTERPARTY_NOT_ACCEPTING'

Categorised reason why a securities transfer is delayed past the regulatory deadline.

  • COUNTERPARTY_NOT_INSTRUCTING - The counterparty has not yet instructed the transfer.
  • COUNTERPARTY_NOT_RESPONDING - The counterparty is not responding.
  • COUNTERPARTY_DOES_NOT_AGREE_TO_DELIVERY_DETAILS - The counterparty does not agree to the delivery details.
  • COUNTERPARTY_NOT_ACCEPTING - The counterparty is not accepting the transfer.