Sign in

v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Asset Transfer

Create Internal Asset Transfer

The Internal Transfers API is a system that facilitates the transfer of cash and/or securities from one account to another at the same brokerage firm or bank. The transfers are permitted only if both accounts are under the same ownership.

post/asset-transfers/transfers

Request body

OR

Example request

{
  "source": "DWBG000052",
  "destination": "LKKZ000004",
  "comment": "Hey! Welcome to DriveWealth Developer Docs!",
  "metadata": {
    "myCustomKey": "myCustomValue"
  }
}

Response

Initiating a transfer was successful

idstring

The unique identifier of the internal transfer.

statusstring

The status of the internal transfer.

sourcestring

The user's unique account number, that is human readable.

sourceAccountIDstring

It's a unique source account id, that is human readable.

destinationstring

The user's unique account number, that is human readable.

destinationAccountIDstring

It's a unique destination account id, that is human readable.

clearingNostring

The DTCC clearing number of the broker. Refer DTCC broker API to fetch full supported list.

cashnumber

The cash amount to be transferred.

incomingCashnumber

The incoming cash amount to be transferred.

outgoingCashnumber

The outgoing cash amount to be transferred.

commentstring

A way to store a message/comment on the this object.

metadataMetadata

The metadata object allows for creating a maximum of 5 keys (max 36 characters) and each value cannot exceed more than 128 bytes.

createdstring date-time
updatedstring date-time

Example response

{
  "id": "int_f3cab2e5-3212-42e4-a903-25259d2c4830",
  "status": "STARTED",
  "source": "DWBG000052",
  "sourceAccountID": "d6a776bc-be5c-47df-94eb-baf914f1847c.1738660911962",
  "destination": "DWBG000052",
  "destinationAccountID": "c815c129-27cd-46f2-b316-ab6bde9aff62.1737384219426",
  "clearingNo": "0001",
  "transferType": {
    "name": "FULL",
    "description": "Full Transfer"
  },
  "partner": {
    "id": "80f9b672-120d-4b73-9cc9-42fb3262c4b9",
    "name": "Tendies Trading Company"
  },
  "cash": 1000,
  "incomingCash": 1000,
  "outgoingCash": 1000,
  "positions": [
    {
      "symbol": "AMD",
      "cusip": "US0256789",
      "quantity": 3,
      "instrumentType": "EQUITY"
    }
  ],
  "incomingPositions": [
    {
      "symbol": "AMD",
      "cusip": "US0256789",
      "quantity": 3,
      "instrumentType": "EQUITY"
    }
  ],
  "outgoingPositions": [
    {
      "symbol": "AMD",
      "cusip": "US0256789",
      "quantity": 3,
      "instrumentType": "EQUITY"
    }
  ],
  "comment": "Hey! Welcome to DriveWealth Developer Docs!",
  "metadata": {
    "myCustomKey": "myCustomValue"
  },
  "created": "2022-12-22T06:07:41Z",
  "updated": "2022-12-22T06:07:41Z",
  "auditDetails": [
    {
      "comment": "Hey! Welcome to DriveWealth Developer Docs!",
      "timestamp": "2022-12-22T06:07:41Z"
    }
  ]
}