Transfer Cash Externally

POST

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

POST

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

curl -X POST https://localhost:5000/gw/api/v1/external-cash-transfers \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "instructionType": "DEPOSIT",
  "instruction": {
    "accountId": "U46377",
    "amount": 100,
    "bankInstructionMethod": "WIRE",
    "bankInstructionName": "Instruction",
    "clientInstructionId": 7013045,
    "currency": "USD",
    "fromAccountNumber": "U46377",
    "identifier": "indentifier",
    "senderInstitutionName": "Senders Institution name",
    "sendingInstitution": "Sending Institution name",
    "specialInstruction": "U46377"
  }
}'

{
  "status": 202,
  "instructionSetId": 2480,
  "instructionResult": {
    "clientInstructionId": 7008143,
    "instructionType": "DEPOSIT",
    "instructionStatus": "PENDING",
    "instructionId": 43092468
  }
}

Initiate request to deposit or withdrawal between IBKR account and bank account. More information on transfer methods can be found here - https://www.interactivebrokers.com/campus/trading-lessons/cash-and-position-transfers

Scope: transfers.write
Security Policy: Signed JWT

Initiate request to deposit or withdrawal between IBKR account and bank account. More information on transfer methods can be found here - https://www.interactivebrokers.com/campus/trading-lessons/cash-and-position-transfers<br><br>**Scope**: `transfers.write`<br>**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

This endpoint expects an object.

instructionTypeenumRequired

Allowed values:

instructionobjectRequired

Response

Accepts request to create a new instruction asynchronously

statusdouble

HTTP status code for the request.

instructionSetIddouble

Identifier of the instruction set grouping the submitted instructions.

instructionResultobjectOptional

Result of the submitted instruction.

Errors

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error