get_instruction_name

https://[domain]/ws/fb/new-request

Query saved bank instruction(s) for a specific account(s)
Customer Type: Fully Disclosed and Advisor-Clients.

Request Parameters

Name	Type	Description
account_number	String	IBKR account ID of the advisor/broker client account requesting to pull saved bank instructions for.
id	ID is a unique identifier which you create for each funding request.	ID cannot be reused ID must be established in sequential order ie 1, 2, 3, 4 or 100, 101, 102, 103 not 777, 589, 123 Max 10 digits for file ID Max 20 digits for counterparty transaction ID
method	ACHUS ACHCA WIRE	ACHUS includes: Single Euro Payment Area (SEPA) US Automated Clearing House (ACH). ACHCA: Canadian Electronic Funds Transfer WIRE: Electronic fund transfer through the fed wire system.

Name

Type

Description

account_number

String

IBKR account ID of the advisor/broker client account requesting to pull saved bank instructions for.

ID is a unique identifier which you create for each funding request.

ID cannot be reused
ID must be established in sequential order ie 1, 2, 3, 4 or 100, 101, 102, 103 not 777, 589, 123
Max 10 digits for file ID
Max 20 digits for counterparty transaction ID

method

ACHUS

ACHCA

WIRE

ACHUS includes:

Single Euro Payment Area (SEPA)
US Automated Clearing House (ACH).

ACHCA: Canadian Electronic Funds Transfer

WIRE: Electronic fund transfer through the fed wire system.

XSD

Copy

<xsd:complexType name="get_instruction_name" maxOccurs="unbounded" ><xsd:sequence>
<xsd:element name="account_number" type="string" maxOccurs="1" />
<xsd:element name="id" type="Non-Negative-Integer " maxOccurs="1" />
</xsd:sequence>

Sample

Copy

<?xml version="1" encoding="UTF-8"?><instruction_set
    xmlns="http://www.interactivebrokers.com/fbfb_instruction_set"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.interactivebrokers.com/fbfb_instruction_set fbfb_instruction_set.xsd "
    creation_date="2019-01-11" id="2" version="1.2">
    <get_instruction_name id="2">
        <account_number>U139838</account_number>
        <method>WIRE</method>
    </get_instruction_name>  
</instruction_set>

Response Parameters

Name

Type

Description

creation_date

YYYY-MM-DD

Date/Time which the file was processed by IBKR.

Id of the instruction to which this node is a response

instr_id

Id of the instruction to which this node is a response

ID is a unique identifier which you create for each funding request.

status

PENDING

PROCESSED

REJECTED

Current status of the instruction associated with the instr_id.

code

String

Error code- (included only if there is an error)

description

String

Description of the error (included only if there is an error)

ib_instr_id

String

ID defined by IBKR.

client_ib_acct_id

String

IBKR account ID of the advisor/broker client account which the instruction name is being pulled for.

method

ACHUS

ACHCA

WIRE

ACHUS includes:

Single Euro Payment Area (SEPA)
US Automated Clearing House (ACH).

ACHCA: Canadian Electronic Funds Transfer

WIRE: Electronic fund transfer through the fed wire system.

currency

USD	HUF
EUR	CZK
GBP	CNH
CAD	DKK
JPY	RUB
HKD	ILS
AUD	NOK
CHF	SGD
MXN	PLN
SEK	ZAR
NZD

Currency of the funds being requested for withdrawal.

instruction_name

String

Name of the previously created instruction (saved bank/account number.

Sample

Copy

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<instr_result_set xmlns="http://www.interactivebrokers.com/fbfb_result_set"
    id="11112987" version="1.2" creation_date="2022-03-03-05:00">
    <get_instructions_result>
        <instr_id>11114666</instr_id>
        <status>PROCESSED</status>
        <ib_instr_id>11023534</ib_instr_id>
        <client_ib_acct_id>U139838</client_ib_acct_id>
        <method>WIRE</method>
        <instruction_details>
            <instruction_name>TestHM</instruction_name>
            <type>LOCAL_BANK</type>
            <currency>USD</currency>
        </instruction_details>
        <instruction_details>
            <instruction_name>testwire</instruction_name>
            <type>LOCAL_BANK</type>
            <currency>USD</currency>
        </instruction_details>
        <instruction_details>
            <instruction_name>Test Instructionf</instruction_name>
            <type>LOCAL_BANK</type>
            <currency>USD</currency>
        </instruction_details>
        <instruction_details>
            <instruction_name>ASADFASFA</instruction_name>
            <type>LOCAL_BANK</type>
            <currency>USD</currency>
        </instruction_details>
        <instruction_details>
            <instruction_name>AFAFSADF</instruction_name>
            <type>LOCAL_BANK</type>
            <currency>USD</currency>
        </instruction_details>
        <instruction_details>
            <instruction_name>APRIL 22</instruction_name>
            <type>LOCAL_BANK</type>
            <currency>USD</currency>
        </instruction_details>
    </get_instructions_result>
</instr_result_set>