Create securities transfer
Changed onCreates a securities transfer, moving a position in a single instrument between an Upvest account and an external custodian.
Set direction to INCOMING to move securities into an Upvest account, or OUTGOING to move them out to an external custodian. Only full units can be transferred — fractional quantities are not supported by the SWIFT messaging used for settlement. Unfulfilled incoming transfer requests are cancelled automatically after 30 days.
See the securities transfers guide (TOL / BYOL / Omnibus) for the transfer stages and settlement details.
Request
- Base URL: https://sandbox.upvest.co
- URL: https://sandbox.upvest.co/securities_transfers
- Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: securities_transfers:admin)
Headers
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
Response
Securities Transfer created
Changes
- breaking
added
subschema #1: User unique identifier.to therequest propertyallOflist - breaking
the
request property type changed fromstringto no type, and format fromuuidto no format - breaking
the response property
became optional for the status - breaking
the
response's property type changed fromstringto no type, and format fromuuidto no format for status - info
added the new optional request property
- info
the request property
became optional - info
the request property
became optional - info
added the optional property
to the response with the status - info
added
subschema #1: User unique identifier.to theresponse propertyallOflist for the response status
- breaking