DRdrivewealth
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

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/asset-transfers/transfers
  • Auth
    HTTP bearer

Request body

OR
OR
OR

Example request

{
  "source": "FFFF000005",
  "destination": "FFFF000031",
  "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

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

sourceAccountIDstring

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

destinationstring

sensitive 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

sensitive A way to store a message/comment on the this object. Do not put personal or account data in this field.

metadataMetadata

sensitive The metadata object allows for creating a maximum of 10 keys (max 36 characters) and each value cannot exceed 512 bytes. Do not put personal or account data in this field.

createdstring date-time
updatedstring date-time

Example response

{
  "id": "int_123e4567-e89b-12d3-a456-00000000003b",
  "status": "STARTED",
  "source": "FFFF000005",
  "sourceAccountID": "123e4567-e89b-12d3-a456-00000000001a.1234567890129",
  "destination": "FFFF000005",
  "destinationAccountID": "123e4567-e89b-12d3-a456-00000000001b.1234567890130",
  "clearingNo": "0001",
  "transferType": {
    "name": "FULL",
    "description": "Full Transfer"
  },
  "partner": {
    "id": "123e4567-e89b-12d3-a456-000000000005",
    "name": "Tendies Trading Company"
  },
  "cash": 1000,
  "incomingCash": 1000,
  "outgoingCash": 1000,
  "positions": [
    {
      "symbol": "AMD",
      "cusip": "000000000",
      "quantity": 3,
      "instrumentType": "EQUITY"
    }
  ],
  "incomingPositions": [
    {
      "symbol": "AMD",
      "cusip": "000000000",
      "quantity": 3,
      "instrumentType": "EQUITY"
    }
  ],
  "outgoingPositions": [
    {
      "symbol": "AMD",
      "cusip": "000000000",
      "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"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.