---
title: "View Bank Instructions"
method: POST
path: "/gw/api/v1/bank-instructions/query"
tags: ["accountManagementBanking"]
---

# View Bank Instructions

`POST /gw/api/v1/bank-instructions/query`

View active bank instructions for an accountId.<br><br>**Scope**: `bank-instructions.read`<br>**Security Policy**: `Signed JWT`

## Path parameters

- `client-id` string, required

## Request body

- object
  - `instructionType` 'QUERY_BANK_INSTRUCTION' | 'QUERY_RECENT_RECURRING_EVENTS' | 'QUERY_RECURRING_INSTRUCTIONS', required
  - `instruction` union, required
    - QueryBankInstruction
      - `clientInstructionId` number, double, required
      - `accountId` string, required
      - `bankInstructionMethod` 'ACH' | 'WIRE' | 'USACH' | 'CAACH' | 'SEPA' | 'eDDA' | 'eGIRO' | 'OPEN_BANKING', required
    - QueryRecentRecurringEvents
      - `clientInstructionId` number, double, required
      - `ibReferenceId` number, double, required
      - `numberOfTransactions` number, double
    - QueryRecurringInstructions
      - `clientInstructionId` number, double, required
      - `accountId` string, required

## Response `201`

Instruction successfully created and processed synchronously

- union
  - QueryRecentRecurringEventResponse
    - `status` number, double, required
    - `instructionSetId` number, double, required
    - `instructionResult` QueryRecentRecurringEventResult
      - `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' | 'PROCESSED' | 'REJECTED' | 'PENDING_VERIFICATION', required
      - `instructionId` number, double, required
      - `ibReferenceId` number, double
      - `description` string
      - `recurringInstructionName` string, required
      - `recurringTransactionType` string, required
      - `recurringTransactionStatus` string, required
      - `amount` number, double, required
      - `currency` string, required
      - `method` string, required
      - `transactionHistory` QueryRecentRecurringEventResultTransactionHistory, required
        - `maxNumberOfTransactions` integer
        - `result` QueryRecentRecurringEventResultTransactionHistoryResultItems[]
          - `ibRequestId` integer
          - `status` string
  - QueryBankInstructionResponse
    - `status` number, double, required
    - `instructionSetId` number, double, required
    - `instructionResult` QueryBankInstructionResult
      - `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' | 'PROCESSED' | 'REJECTED' | 'PENDING_VERIFICATION', required
      - `instructionId` number, double, required
      - `ibReferenceId` number, double
      - `description` string
      - `accountId` string, required
      - `bankInstructionMethod` 'WIRE' | 'ACH' | 'USACH' | 'CAACH' | 'SEPA' | 'eDDA' | 'eGIRO' | 'OPEN_BANKING', required
      - `bankInstructionDetails` QueryBankInstructionResultBankInstructionDetailsItems[], required
        - `instructionName` string, required
        - `type` string, required
        - `currency` string, required
        - `instructionStatus` string, required
        - `bankRoutingNumber` string, required
        - `bankAccountNumber` string, required
  - QueryRecurringInstructionsResponse
    - `instructionResult` QueryRecurringInstructionsResult
      - `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' | 'PROCESSED' | 'REJECTED' | 'PENDING_VERIFICATION', required
      - `instructionId` number, double, required
      - `ibReferenceId` number, double
      - `description` string
      - `accountId` string, required
      - `recurringInstructions` QueryRecurringInstructionsResultRecurringInstructionsItems[], required
        - `requestId` integer
        - `bankInstructionName` string
        - `transactionType` string
        - `bankInstructionMethod` string
        - `amount` number, double
        - `currency` string
        - `frequency` string
        - `startDate` string
        - `endDate` string

## 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)