View Cash Balances

POST

/gw/api/v1/balances/query

POST

/gw/api/v1/balances/query

curl -X POST https://localhost:5000/gw/api/v1/balances/query \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "instructionType": "QUERY_WITHDRAWABLE_CASH_EQUITY",
  "instruction": {
    "accountId": "U87440",
    "clientInstructionId": 7009005,
    "currency": "USD"
  }
}'

{
  "instructionResult": {
    "accountId": "U46377",
    "availableEquityValue": 121538.65,
    "clientInstructionId": 7013230,
    "currency": "USD",
    "ibReferenceId": 0,
    "instructionId": 43133309,
    "instructionStatus": "PROCESSED",
    "instructionType": "QUERY_WITHDRAWABLE_CASH_EQUITY",
    "withdrawableCashAmount": 250000
  },
  "instructionSetId": 17791,
  "status": 201
}

View available cash for withdrawal and account equity value by accountId

Scope: balances.read
Security Policy: Signed JWT

Authentication

AuthorizationBearer

RS256-signed JWT access token signed with your registered private key.

Path parameters

client-idstringRequired

The client's clientId

Request

Create an query request body

instructionTypeenumRequired

Allowed values:

instructionobjectRequired

Response

Instruction successfully created and processed synchronously

QueryWithdrawableCashEquityResponseobject

Response containing withdrawable cash and equity for an account.

Errors

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error