Securities Transfers

List securities transfers

Changed on

Returns the list of securities transfers.

Restrict the list to one direction with the direction query parameter, and page through results with the offset and limit query parameters; meta.total_count gives the total number of matching transfers.

See the securities transfers guide (TOL / BYOL / Omnibus) for the transfer stages and settlement details.

get/securities_transfers

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, securities_transfers:read)

Query parameters

direction'INCOMING' | 'OUTGOING' required

Filter the list by transfer direction.

sort'created_at' | 'updated_at'

Sort the result by created_at, updated_at.

order'ASC' | 'DESC'

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

offsetinteger

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

limitinteger

Use the limit argument to specify the maximum number of items returned.

user_idstring uuid

Unique identifier of the user, as a UUID.

Filters results by user ID. Universally Unique Identifier (UUID).

account_idstring uuid

Universally Unique Identifier (UUID) of the account.

Filters results by account ID. Universally Unique Identifier (UUID).

account_group_idstring uuid

Universally Unique Identifier (UUID) of the account group.

Filters results by account group ID. Universally Unique Identifier (UUID).

status'NEW' | 'PROCESSING' | 'CANCELLED' | 'SETTLED'

Status of the securities transfer

  • NEW - Securities transfer is created but not started processing.
  • PROCESSING - Securities transfer is in processing.
  • SETTLED - Securities transfer was successfully settled.
  • CANCELLED - Securities transfer was cancelled.

Response

Securities Transfers list

Changes

  • 2495225a281aRevision changes
    • breaking

      the response property // became optional for the status

    • breaking

      the // response's property type changed from string to no type, and format from uuid to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added subschema #1: User unique identifier. to the // response property allOf list for the response status