traditional_bank_link_verification

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

  • Used to verify micro deposits for ACH instructions initiated via DAM.

  • Only applicable if response from ach_instruction request returns PENDING or PENDING_VERIFICATION.

  • Customer Type: Fully Disclosed, Non-Disclosed and Advisor-Clients.

  1. We use EWS (Early Warning System) to verify ACH Instructions.

  2. Within 1-3 business days, two random credits (deposits) each less than one dollar and a corresponding debit (withdrawal) will be issued to the clients bank account.

  3. Client will need to monitor their bank account for these transactions as they will be needed to confirm this funding instruction. Note that these transactions may take place on different days.

  4. Once the client has these amounts, submit traditional_bank_link request to verify the amounts. Once verified, the client can use ACH instructions for deposit and withdrawal requests.

Name Type Description

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

pending_ib_instr_id

String

Instruction id of the pending transaction.

instruction_name

String; max 32 characters

Name of the banking instructions with IBKR. This should match the instruction_name that was provided in theach_instruction request.

client_ib_acct_id

String

Client account number at IBKR.

instruction_method

ACHUS

Static value and will always be ACHUS

credit_amount_1

Numeric value

Cash amount that IBKR credited /debited to bank account. The order which the amounts are send does not matter. 3 attempts are allowed for confirming these credit amounts.

credit_amount_2

Numeric value

Cash amount that IBKR credited /debited to bank account. The order which the amounts are send does not matter. 3 attempts are allowed for confirming these credit amounts.

XSD

Copy 
<xsd:complexType name="traditional_bank_link_verification" maxOccurs="unbounded" >
<xsd:sequence>
<xsd:attribute name="id" use="required" type="Non-Negative-Integer" maxOccurs="1" />
<x/sd:sequence>
<xsd:sequence>
 <xsd:element name="pending_ib_instr_id" use="required" type="string" maxOccurs="1" />
 <xsd:element name="client_ib_acct_id" use="required" type="string" maxOccurs="1" />
 <xsd:element name="instruction_name" use="required" type="string" maxOccurs="1" />
 <xsd:element name="instruction_method" use="required" type="instruction_method" maxOccurs="1" />
 <xsd:element name="credit_amount_1" use="decimal" type="string" maxOccurs="1" />
 <xsd:element name="credit_amount_1" use="decimal" type="bank_client_acct_type_code" 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.1">
<traditional_bank_link_verification>
         <pending_ib_instr_id>1234567</pending_ib_instr_id>
         <client_ib_acct_id>U123456</client_ib_acct_id>
         <instruction_name>Test-ACH-Instr-Any-Name</instruction_name>
         <instruction_method>ACHUS</instruction_method>
         <credit_amount_1>0.28</credit_amount_1>
         <credit_amount_2>0.39</credit_amount_2>
     </traditional_bank_link_verification>
</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 which you create for each funding request.

status

PROCESSED

REJECTED

PROCESSED: ACH Instruction was processed.

REJECTED: ACH instruction cannot be verified and a different funding method will need to be used

PENDING: Accepted for processing. Micro amount request is processed in batch, the request will remain PENDING until it is processed.

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>