deposit_funds

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

  • Used to Notify IBKR of Incoming Funds.

  • Customer Type: Fully-Disclosed and Advisor-Clients

  • Wire: The request is indicating a wire deposit notification. The client still needs to contact their bank (using Wire Instructions provided in attached Wire Instructions .xlsx) to initiate the transfer. The deposit notification is used by IBKR to match the deposited funds to the account.

  1. Notify IBKR of the incoming funds by sending deposit_funds notification to IBKR via RESTful Web API.

  2. Account holder will provide IBKR’s Wire Instructions to the sending institution to initiate the transfer.

  3. Sending Institution will send funds to Interactive Brokers

    • IF Funds are sent to IBKR and no deposit notification is created, the funds will not be automatically credited to the account. A new deposit notification with the correct amount will need to be created so our sytmem can match the funds to the account.

  4. IBKR will credit funds to the Client Account.

    • IBKR will send a notification via API once the funds have been credited to the account using the /callback service.

    • Optionally, use get-status to query the status of the deposit_funds request

• PROCESSED = IBKR has received the funds and funds have been credited to the account.

• Funds are available for Trading.

• PENDING= IBKR has not received the funds yet.

  • ACH: Only if saved bank instructions are on the account.

  • Wire

    • Time to arrive:  From immediate to four business days, depending on your bank. Non-U.S. banks are generally at the longer end of the range. Credit to account is immediate upon arrival

    • Limitations: The Withdrawal Hold Period is three business days (you may withdraw funds after three business days). A wire cannot be internally transferred during the three-day hold period.

  • ACH- Funds are credited to the account after a 4-business day credit hold.

  • Time to Arrive

    • ACH requests of more than $25,000 will be received from your bank on the next business day and credited to your account after four business days under normal circumstances.

    • ACH requests of $25,000 or less received by 11:00am ET will be credited to your account same day and available to trade after four business days under normal circumstances.

    • ACH requests of $25,000 or less received after 11:00am ET will be received from your bank on the next business day and credited to your account after four business days under normal circumstances.

  • Limitations: ACH deposits are limited to $100,000 over seven business days.

Name Type Description

account_number

String

IBKR account ID of the advisor/broker client account which funds are being deposited to. 

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

amount

Decimal

Amount being deposited to the clients IBKR Account.

method

ACH

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 sent to IBKR.

saved_instruction_name

String

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

*Only required for ACH initiated by IBKR.

initiated_by_ib

Boolean

Always “true”

*Only required for ACH initiated by IBKR.

identifier

String

Bank Account Number

sending_institution

String

Bank Name

special_instructions

String

Any special instructions associated with the deposit.

IRA Boolean

true

false
ira_contribution_type

ROLLOVER

LATE_ROLLOVER

EMPLOYER_SEP_CONTRIBUTION

DIRECT_ROLLOVER

CONTRIBUTION

SPOUSAL_CONTRIBUTION

ROLLOVER:Amount is distributed from a retirement account and 'rolled over' to the same or other retirement account

LATE_ROLLOVER: Late rollover

EMPLOYER_SEP_CONTRIBUTION: Simplified employee pension - employer contribution

DIRECT_ROLLOVER:Direct rollover from a qualified plan

CONTRIBUTION: Regular IRA contributions

SPOUSAL_CONTRIBUTION:Spousal IRA contributions
ira_tax_year_type

CURRENT

PRIOR

Current: Current Tax Year

Prior: Prior Tax Year
from_ira_type

NONE

TRADITIONAL

ROLLOVER

ROTH

SEP

EDUCATION

TRADITIONAL_INHERITED

ROTH_INHERITED

SEP_INHERITED

RETIREMENT_SAVINGS_PLAN

SPOUSAL_RETIREMENT_SAVINGS_PLAN

TAX_FREE_SAVINGS_ACCOUNT

  
instruction_name String Name of the recurring transaction.
frequency

MONTHLY

QUARTERLY

YEARLY

 Frequency which the transaction will take place.
start_date YYYY-MM-DD Date which recurring transaction will start.
end_date YYYY-MM-DD Date which the recurring transaction will end.

XSD

Copy 
<xsd:complexType name="deposit_funds" maxOccurs="unbounded" >
<xsd:sequence>
<xsd:attribute name="id" use="required" type="Non-Negative-Integer" maxOccurs="1" />
<x/sd:sequence>
<xsd:sequence>
<xsd:element name="account_number" use="required" 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="amount" use="required" type="decimal" maxOccurs="1" />
<xsd:element name="saved_instruction_name" use="optional"  type="string" maxOccurs="1" />
<xsd:element name="special_instructions" use="optional"  type="string" maxOccurs="1" />
<xsd:element name="initiated_by_ib" use="optional" type="boolean" maxOccurs="1" />
<xsd:element name="identifier" use="Required for Wires" type="string" maxOccurs="1" />
<xsd:element name="IRA" use="Required for IRA deposits" type="IRA" maxOccurs="1" />
<xsd:element name="ira_tax_year_type" use="Required for IRA deposits" type="ira_tax_year_type" maxOccurs="1" />
<xsd:element name="from_ira_type" use="Required for IRA deposits" type="from_ira_type" maxOccurs="1" />
<xsd:element name="ira_contribution_type" use="Required for IRA deposits" type="ira_contribution_type" maxOccurs="1" />
</xsd:sequence>
<xs:complexType name="recurr_detail">
<xs:element name="start_date" type="xs:date" />
<xs:element name="end_date" type="xs:date" minOccurs="0"/>
<xs:element name="frequency" type="is:RecurrFrequency" />
</xs:complexType>
  

Sample

Copy
Wire Deposit
<?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">
    <deposit_funds id="2">
        <account_number>U123456</account_number>
        <amount>1001.00</amount>
        <currency>USD</currency>
        <method>WIRE</method>
        <sending_institution>Chase Bank</sending_institution>
        <identifier>123123</identifier>
    </deposit_funds> 
</instruction_set>
Copy
ACH Deposit
<?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">
    <deposit_funds id="2">
        <account_number>U123456</account_number>
        <amount>1001.00</amount>
        <currency>USD</currency>
        <method>ACH</method>
        <saved_instruction_name>Chase Checking</saved_instruction_name>
    </deposit_funds> 
</instruction_set>
Copy
IRA Deposit
<?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">
    <deposit_funds id="2">
           <account_number>U123456</account_number>
           <amount>1001.00</amount>
           <currency>USD</currency>
           <method>ACH</method>
           <saved_instruction_name>Chase Checking</saved_instruction_name>
           <IRA>true</IRA>    
           <ira_contribution_type>CONTRIBUTION</ira_contribution_type>
           <ira_tax_year_type>CURRENT</ira_tax_year_type>
           <from_ira_type>NONE</from_ira_type>
           </deposit_funds> 
</instruction_set>
Copy
Recurring ACH Deposit
<?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">
    <deposit_funds id="2">
        <account_number>U123456</account_number>
        <amount>1001.00</amount>
        <currency>USD</currency>
        <method>ACH</method>
        <saved_instruction_name>Chase Checking</saved_instruction_name>
         <recurr_detail>
            <instruction_name>Monthly Deposit</instruction_name>
            <start_date>2023-09-12</start_date>
            <frequency>MONTHLY</frequency>
        </recurr_detail>    
</deposit_funds> 
</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

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.0" encoding="UTF-8" standalone="yes"?>
<instr_result_set xmlns="http://www.interactivebrokers.com/fbfb_result_set"
    id="11112980" version="1.2" creation_date="2022-03-03-05:00">
    <deposit_result>
        <instr_id>11114659</instr_id>
        <status>PENDING</status>
        <ib_instr_id>11023528</ib_instr_id>
        <code></code>
        <description></description>
    </deposit_result>
</instr_result_set>