View Cash Balances

POST

/gw/api/v1/external-cash-transfers/query

POST

/gw/api/v1/external-cash-transfers/query

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

{
  "instructionResult": {
    "accountId": "U46377",
    "allowedTransferAmountToMaster": 0,
    "allowedTransferAmountToMasterNoBorrow": 0,
    "clientInstructionId": 7013230,
    "currency": "EUR",
    "ibReferenceId": 0,
    "instructionId": 43133309,
    "instructionStatus": "PROCESSED",
    "instructionType": "QUERY_WITHDRAWABLE_FUNDS",
    "withdrawableAmount": 0,
    "withdrawableAmountNoBorrow": 0
  },
  "instructionSetId": 17791,
  "status": 201
}

View available cash for withdrawal with and without margin loan by accountId

Scope: transfers.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 external cash transfer query request body

instructionTypeenumRequired

Allowed values:

instructionobjectRequired

Response

Instruction successfully created and processed synchronously

QueryWithdrawableAmountsResponseobject

Response containing withdrawable amounts for an account.

QueryWithdrawableAmountsWithoutOriginHoldResponseobject

Response containing withdrawable amounts excluding origination hold.

Errors

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error