---
title: "View Cash Balances"
method: POST
path: "/gw/api/v1/external-cash-transfers/query"
tags: ["accountManagementBanking"]
---

# View Cash Balances

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

View available cash for withdrawal with and without margin loan by accountId<br><br>**Scope**: `transfers.read`<br>**Security Policy**: `Signed JWT`

## Path parameters

- `client-id` string, required

## Request body

- object
  - `instructionType` 'QUERY_WITHDRAWABLE_FUNDS' | 'QUERY_IRA_CONTRIBUTIONS', required
  - `instruction` union, required
    - QueryWithdrawableFunds
      - `clientInstructionId` number, double, required
      - `accountId` string, required
      - `currency` string, required
      - `bankRoutingNumber` string — If bankRoutingNumber is provided then bankAccountNumber is also required, cannot be passed with bankInstructionName
      - `bankAccountNumber` string — If bankAccountNumber is provided then bankRoutingNumber is also required, cannot be passed with bankInstructionName
      - `bankInstructionName` string — bankInstructionName cannot be passed with (bankAccountNumber or bankRoutingNumber)
    - QueryIRAContributions
      - `clientInstructionId` number, double, required
      - `accountId` string, required
      - `year` string, required

## Response `201`

Instruction successfully created and processed synchronously

- union
  - QueryWithdrawableAmountsResponse
    - `status` number, double, required
    - `instructionSetId` number, double, required
    - `instructionResult` QueryWithdrawableAmountsInstructionResult
      - `clientInstructionId` number, double, required
      - `instructionType` 'ACH_INSTRUCTION' | 'CANCEL_INSTRUCTION' | 'COMPLEX_ASSET_TRANSFER' | 'DELETE_BANK_INSTRUCTION' | 'DEPOSIT' | 'DWAC' | 'EXTERNAL_POSITION_TRANSFER' | 'FOP' | 'QUERY_RECENT_INSTRUCTIONS' | 'QUERY_WITHDRAWABLE_FUNDS' | 'INTERNAL_POSITION_TRANSFER' | 'INTERNAL_CASH_TRANSFER' | 'MICRO_AMOUNT' | 'PREDEFINED_DESTINATION_INSTRUCTION' | 'TRADITIONAL_BANK_INSTRUCTION_VERIFICATION' | 'WITHDRAWAL' | 'QUERY_IRA_CONTRIBUTIONS' | 'EDDA_INSTRUCTION' | 'QUERY_RECENT_RECURRING_EVENTS' | 'QUERY_RECURRING_INSTRUCTIONS' | 'QUERY_ACCOUNT_BALANCES' | 'QUERY_BANK_INSTRUCTION' | 'QUERY_WITHDRAWABLE_CASH_EQUITY', required
      - `instructionStatus` 'PENDING' | 'REJECTED' | 'PROCESSED', required
      - `instructionId` number, double, required
      - `ibReferenceId` number, double
      - `description` string
      - `error` QueryWithdrawableAmountsInstructionResultError
        - `errorCode` string, required
        - `errorMessage` string, required
      - `accountId` string, required
      - `currency` string, required
      - `withdrawableAmount` number, double, required
      - `withdrawableAmountNoBorrow` number, double, required
      - `allowedTransferAmountToMaster` number, double, required
      - `allowedTransferAmountToMasterNoBorrow` number, double, required
  - QueryWithdrawableAmountsWithoutOriginHoldResponse
    - `status` number, double, required
    - `instructionSetId` number, double, required
    - `instructionResult` QueryWithdrawableAmountsWithoutOriginHoldResult
      - `clientInstructionId` number, double, required
      - `instructionType` 'ACH_INSTRUCTION' | 'CANCEL_INSTRUCTION' | 'COMPLEX_ASSET_TRANSFER' | 'DELETE_BANK_INSTRUCTION' | 'DEPOSIT' | 'DWAC' | 'EXTERNAL_POSITION_TRANSFER' | 'FOP' | 'QUERY_RECENT_INSTRUCTIONS' | 'QUERY_WITHDRAWABLE_FUNDS' | 'INTERNAL_POSITION_TRANSFER' | 'INTERNAL_CASH_TRANSFER' | 'MICRO_AMOUNT' | 'PREDEFINED_DESTINATION_INSTRUCTION' | 'TRADITIONAL_BANK_INSTRUCTION_VERIFICATION' | 'WITHDRAWAL' | 'QUERY_IRA_CONTRIBUTIONS' | 'EDDA_INSTRUCTION' | 'QUERY_RECENT_RECURRING_EVENTS' | 'QUERY_RECURRING_INSTRUCTIONS' | 'QUERY_ACCOUNT_BALANCES' | 'QUERY_BANK_INSTRUCTION' | 'QUERY_WITHDRAWABLE_CASH_EQUITY', required
      - `instructionStatus` 'PENDING' | 'REJECTED' | 'PROCESSED', required
      - `instructionId` number, double, required
      - `ibReferenceId` number, double
      - `description` string
      - `error` QueryWithdrawableAmountsWithoutOriginHoldResultError
        - `errorCode` string, required
        - `errorMessage` string, required
      - `accountId` string, required
      - `currency` string, required
      - `withdrawableAmountWithoutOriginationHold` number, double, required
      - `withdrawableAmountWithoutOriginationHoldNoBorrow` number, double, required

## Other responses

- `400` — Returns a Problem detail instance representing a bad request.
- `403` — Returns a Problem detail instance representing a forbidden request.
- `422` — Returns a Problem detail instance representing a business error.
- `500` — Returns a Problem detail instance representing an internal server error.

---

[API](https://skmtc.net/interactivebrokers/apis/api-reference.md) · [All operations](https://skmtc.net/interactivebrokers/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/interactivebrokers/api-reference/revisions/67f9f562c2c6/schema)