Manage Bank Instructions

POST

/gw/api/v1/bank-instructions

POST

/gw/api/v1/bank-instructions

$ curl -X POST https://api.ibkr.com/gw/api/v1/bank-instructions \
>      -H "Content-Type: application/json" \
>      -d '{
>   "instructionType": "ACH_INSTRUCTION",
>   "instruction": {
>     "accountId": "U223454",
>     "achType": "DEBIT_CREDIT",
>     "bankInstructionCode": "USACH",
>     "bankInstructionName": "TestInstr",
>     "clientAccountInfo": {
>       "bankAccountNumber": "101267576983",
>       "bankAccountTypeCode": 0,
>       "bankName": "JPM Chase",
>       "bankRoutingNumber": "202012983"
>     },
>     "clientInstructionId": 1012983,
>     "creditAmount1": 1,
>     "creditAmount2": 2,
>     "currency": "USD",
>     "pendingInstructionId": 35354345
>   }
> }'

1 {
2   "status": 202,
3   "instructionSetId": 2487,
4   "instructionResult": {
5     "clientInstructionId": 80009,
6     "instructionType": "ACH_INSTRUCTION",
7     "instructionStatus": "PENDING",
8     "instructionId": 43092478
9   }
10 }

Create or delete bank instructions by accountId. Only ACH and EDDA are supported for ‘Create’.

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

Path parameters

client-idstringRequired

The client's clientId

Request

This endpoint expects an object.

instructionTypeenumRequired

instructionobjectRequired

Response

Accepts request to create a new instruction asynchronously

statusdouble

instructionSetIddouble

instructionResultobject

Errors

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error