withdraw_funds

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

  • Initiate request to withdraw funds (one time OR recurring), only if standing instruction is in place on the account.

  • Customer Type: Fully Disclosed and Advisor-Clients.

  • For request submitted via DAM, the withdrawal limit is 100K USD. Withdrwal requests for more than 100K USD will need to be submited via the IBKR hosted portal.

  • IBKR allows one free withdrawal request every month. After the first withdrawal (of any kind), IBKR will charge fees for any subsequent withdrawal.

    • Wire: $10

    • ACH: $1

Name Type Description

account_number

String

IBKR account ID of the advisor/broker client account which funds are being withdrawn from

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 requested for withdrawal. 

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 requested for withdrawal.

saved_instruction_name

String

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

date_time_to_occur

2016-04-13T23:15:00+04:00 (UTC plus 4 hours)

2016-04-13T23:15:00-04:00 (UTC minus 4 hours)

2016-04-13T23:15:00Z (UTC

Date which the withdrawal should take place.

If configuring recurring transaction
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="withdraw_funds" maxOccurs="unbounded" >
<xsd:sequence>
 <xsd:element name="account_number" type="string" maxOccurs="1" />
 <xsd:element name="id" type="Non-Negative-Integer" maxOccurs="1" />
 <xsd:element name="currency" type="currency_type" maxOccurs="1" />
 <xsd:element name="method" type="method_type" maxOccurs="1" />
 <xsd:element name="amount" type="decimal” maxOccurs="1" />
 <xsd:element name="saved_instruction_name" type="string” maxOccurs="1" />
 <xsd:element name="date_time_to_occur" type="date_time_to_occur” 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
One Time Withdrawal 
<?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">
         <withdraw_funds id="2441">
        <account_number>U123456</account_number>
        <saved_instruction_name>saved_instruction_name</saved_instruction_name>
        <amount>1000.0</amount>
        <currency>USD</currency>
        <method>WIRE</method>
        <date_time_to_occur>2016-04-13T13:45:00-06:00</date_time_to_occur>
         </withdraw_funds>
</instruction_set>
Copy
Recurring Withdrawal 
<?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">
         <withdraw_funds id="2441">
        <account_number>U123456</account_number>
        <saved_instruction_name>saved_instruction_name</saved_instruction_name>
        <amount>1000.0</amount>
        <currency>USD</currency>
        <method>WIRE</method>
         <recurr_detail>
            <instruction_name>Monthly Withdrawal</instruction_name>
            <start_date>2023-09-12</start_date>
            <frequency>MONTHLY</frequency>
        </recurr_detail>       
  </withdraw_funds>
</instruction_set>
Name Type Description

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="true"?>
<instr_result_set creation_date="2020-04-09-04:00" version="1" id="2" xmlns="http://www.interactivebrokers.com/fbfb_result_set">
    <result>
        <instr_id>2</instr_id>
        <status>PENDING</status>
        <ib_instr_id>1</ib_instr_id>
        <code/>
        <description/>
    </result>
</instr_result_set>