Accounts

Retrieve Account Cash

Retrieves an Account Cash details by accountID.

get/accounts/{accountID}/summary/money

Request

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/accounts/{accountID}/summary/money
  • Auth
    HTTP bearer

Path parameters

accountIDstring required

sensitive The user's unique account identifier.

Example:123e4567-e89b-12d3-a456-000000000004.1234567890125

sensitive

Response

Retrieving Money details was Successful.

accountIDstring

sensitive The user's unique account identifier.

accountNostring

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

tradingType'CASH' | 'MARGIN'

The type of trading the account will participate in.

updatedstring

Timestamp of the last time the deposit was updated.

Example response

{
  "accountID": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
  "accountNo": "FFFF000005",
  "tradingType": "CASH",
  "updated": "2021-04-23T18:41:32.440Z",
  "cash": {
    "cashBalance": -12043.23,
    "cashSettlement": [
      {
        "utcTime": "2021-04-26T13:30:00.001Z",
        "cash": 439.7
      }
    ],
    "cashPendingSettlement": 500
  },
  "payments": {
    "buyingPower": {
      "pendingDepositsAmountAvailable": 20802.71
    },
    "redemptions": {
      "amountWithheldFromRedemptions": 60
    }
  }
}

Changes

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