Retrieve Account Cash

get https://bo-api.drivewealth.io/back-office/accounts/{accountID}/summary/money

Retrieves an Account Cash details by accountID.

Response

Response body

object

accountID

string

The user's unique account identifier.

accountNo

string

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

tradingType

string

The type of trading the account will participate in.

CASH MARGIN

updated

string

Timestamp of the last time the deposit was updated.

cash

object

cashAvailableForTrade

number

An accounts buying power, this figure dictates the total amount of money that can be used for purchases. Will be reduced by pending orders.

cashAvailableForWithdrawal

number

An accounts withdrawal balance, this property only contains settled funds, and money that has already seasoned.

cashBalance

number

An accounts total cash balance, including both settled and un-settled money.

noBuyingPowerReason

array

Reasons for no buying power.

noBuyingPowerReason

cashSettlement

array

An array of objects containing the time of when money settles as a result of a sale.

cashSettlement

cashPendingSettlement

number

The amount of unsettled cash not included in cash available to trade.

pendingPaymentsAmount

number

The total amount of money that is pending due to a recent deposit(s)

payments

object

buyingPower

object

redemptions

object

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://bo-api.drivewealth.io/back-office/accounts/accountID/summary/money \
3
     --header 'accept: application/json' \
4
     --header 'dw-client-app-key: {{yourAppKey}}'


xxxxxxxxxx
31
}
1
{
2
  "accountID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759",
3
  "accountNo": "DWBG000052",
4
  "tradingType": "CASH",
5
  "updated": "2021-04-23T18:41:32.440Z",
6
  "cash": {
7
    "cashAvailableForTrade": 0,
8
    "cashAvailableForWithdrawal": 0,
9
    "cashBalance": -12043.23,
10
    "noBuyingPowerReason": [
11
      null
12
    ],
13
    "cashSettlement": [
14
      {
15
        "utcTime": "2021-04-26T13:30:00.001Z",
16
        "cash": 439.7
17
      }
18
    ],
19
    "cashPendingSettlement": 500,
20
    "pendingPaymentsAmount": 0
21
  },
22
  "payments": {
23
    "buyingPower": {
24
      "pendingDepositsAmountAvailable": 20802.71,
25
      "pendingDepositsAmountNotAvailable": 0

200Retrieving Money details was Successful.