delete_instruction_name

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

  • Delete saved banking instructions

  • Customer Type: Fully Disclosed, Advisor-Clients.

Name Type Description

ib_account_id

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

ACH

WIRE

 

ACH includes:

  • Single Euro Payment Area (SEPA)

  • US Automated Clearing House (ACH).

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 associated with the banking instructions.

saved_instruction_name

String

Name associated with the instructions that need to be deleted.

XSD

Copy 
<xsd:complexType name="delete_instruction_name" maxOccurs="unbounded" >
<xsd:sequence>
 <xsd:element name="ib_account_id" type="string" maxOccurs="1" />
 <xsd:element name="id" type="Non-Negative-Integer " maxOccurs="1" />
 <xsd:element name="reason" type="string " maxOccurs="1" />
<xsd:element name="currency" use=”required” type="currency_type" maxOccurs="1" />
<xsd:element name="method" use=”required” type="method_type" maxOccurs="1" />
<xsd:element name=" saved_instruction_name" use=”required”  type="string” 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="_DATE_" id="_FILEID_" version="1.2">   
    <delete_instruction_name id="_TRANSID_">
        <ib_account_id>U1234567</ib_account_id>
           <method>WIRE</method>
           <currency>USD</currency>
           <instruction_name>Chase Bank Test</instruction_name>
    </delete_instruction_name
</instruction_set>
Name Type Description

creation_date

YYYY-MM-DD

Date/Time which the file was processed by IBKR.

id

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 associated with the 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.

Sample

Copy 
<?xml version="1" encoding="UTF-8" standalone="true"?><instr_result_set creation_date="2020-04-09-04:00" version="1.2" id="2" xmlns="http://www.interactivebrokers.com/fbfb_result_set">
    <result>
        <instr_id>2</instr_id>
        <status>PROCESSED</status>
        <ib_instr_id>1</ib_instr_id>
        <code/>
        <description/>
    </result>
</instr_result_set>