View Bank Instructions

POST

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

POST

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

$ curl -X POST https://api.ibkr.com/gw/api/v1/bank-instructions/query \
>      -H "Content-Type: application/json" \
>      -d '{
>   "instructionType": "QUERY_RECURRING_INSTRUCTIONS",
>   "instruction": {
>     "accountId": "U399192",
>     "bankInstructionMethod": "WIRE",
>     "clientInstructionId": 1012983
>   }
> }'

1 {
2   "instructionResult": {
3     "accountId": "U399192",
4     "clientInstructionId": 12008027,
5     "ibReferenceId": 0,
6     "instructionId": 43104628,
7     "instructionStatus": "PROCESSED",
8     "instructionType": "QUERY_RECENT_INSTRUCTIONS",
9     "recurringInstructions": [
10       {
11         "amount": 1,
12         "bankInstructionMethod": "ACH",
13         "bankInstructionName": "Recurring Test- cpereira",
14         "currency": "USD",
15         "endDate": "2024-12-12 00:00:00.0",
16         "frequency": "MONTHLY",
17         "requestId": 206611807,
18         "startDate": "2024-06-12 00:00:00.0",
19         "transactionType": "DEPOSIT"
20       }
21     ]
22   },
23   "instructionSetId": 14258,
24   "status": 201
25 }

View active bank instructions for an accountId.

Scope: bank-instructions.read
Security Policy: Signed JWT

Path parameters

client-idstringRequired

The client's clientId

Request

Create get instruction name request body

instructionTypeenumRequired

Allowed values:

instructionobjectRequired

Response

Instruction successfully created and processed synchronously

QueryRecentRecurringEventResponseobject

QueryBankInstructionResponseobject

QueryRecurringInstructionsResponseobject

Errors

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error