complex_asset_transfer (International FOP for FA and FD)
https://[domain]/ws/fb/new-request
-
Initiate international assets transfer using free of payment (FOP).
-
For US assets, use fop
-
-
Customer Type: Fully Disclosed and Advisor-Clients.
-
For Non-Disclosed, use complex_asset_transfer (International FOP for Non-Disclosed).
-
Processing Time
-
Transfers are generally completed within 3-5 business days, but this depends on your third-party broker. FOP notices are valid for five business days before expiring. Once the notice has expired IBKR will not accept the shares.
Limitations
-
Transfer of Non-US, bonds, structured products, and options between IBKR and another Non-US Financial Constitution. For incoming transfers, the FOP request is a notification notifying IBKR of the incoming transfer. Transfer of assets will need to be initiated at the third-party broker.
-
An FOP deposit is only a notification of incoming securities while an FOP withdrawal actually transfers securities out.
Request Parameters
| Name | Type | Description |
|---|---|---|
|
id |
ID is a unique identifier which you create for each funding request. |
|
|
direction |
IN OUT |
Indicate if this is an incoming our outgoing transfer. IN = Incoming to IBKR OUT= Transferring out to third party Broker. |
|
ib_acct_id |
String |
IBKR Account Number of the client account that is initiating the transfer. |
|
contra_broker_acct_id |
String |
Client account number at the third party broker. |
|
country |
Alpha-3 code (ISO) |
Country which the contra broker is located. |
|
contract_name |
String |
Name of the contact at the contra broker. |
|
contact_email |
String |
Email of the contact at the contra broker. Note: We use REGEX to validate the email. Validations outlined here. |
|
contact_phone |
String |
Phone number of the contact at the contra broker. Note: We use Google API to validate the Phone Number. Validations outlined here. |
|
security_id |
String |
CUSIP/ISIN number of the security being transferred. |
|
quantity |
Non-Negative Integer |
Number of shares being transferred in/out |
|
asset_type |
BILL BOND CASH FUND OPT STK WAR |
Product type. |
|
security_id_type |
CUSIP ISIN |
Used to determine security_id type that was provided. Either ISIN or CUSIP. |
|
con_id |
String |
Unique Contract ID assigned by Interactive Brokers. |
|
currency |
USD |
Currency of the assets being transferred. |
XSD and Sample
There are 2 options for submitting basic_fop request
»Option 1: Using Security ID (either CUSIP or ISIN)
XSD
<xsd:complexType name="complex_asset_transfer" maxOccurs="unbounded" >
<xsd:sequence>
<xsd:element name="direction" type="direction_type" maxOccurs="1" />
<xsd:element name="ib_acct_id" type="String" maxOccurs="1" />
<xsd:element name="contra_broker_acct_id" type="String" maxOccurs="1" />
xsd:element name="quantity" type="Integer" maxOccurs="1" />
xsd:element name="trading_product" type="Used for ISIN based Requests" maxOccurs="1"
<xsd:element name="country" type="country" maxOccurs="1" />
<xsd:element name="contact_name" type="contact_name" maxOccurs="1" />
<xsd:element name="contact_email" type="contact_email" maxOccurs="1" />
<xsd:element name="contact_phone" type=”contact_phone" maxOccurs="1" />
</xsd:sequence>Sample
<?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="2023-02-02" id="1" version="1.1">
<complex_asset_transfer id="13">
<direction>OUT</direction>
<ib_acct_id>U139838</ib_acct_id>
<contra_broker_info>
<contra_broker_acct_id>221</contra_broker_acct_id>
<country>USA</country>
<contact_name>test</contact_name>
<contact_email>test@mail</contact_email>
<contact_phone>78954</contact_phone>
</contra_broker_info>
<trading_product>
<security_id type="ISIN">459200101</security_id>
<asset_type>STK</asset_type>
<currency>USD</currency>
</trading_product>
<quantity>80</quantity>
</complex_asset_transfer>
</instruction_set>XSD
<xsd:complexType name="complex_asset_transfer" maxOccurs="unbounded" >
<xsd:sequence>
<xsd:element name="direction" type="direction_type" maxOccurs="1" />
<xsd:element name="ib_acct_id" type="String" maxOccurs="1" />
<xsd:element name="contra_broker_acct_id" type="String" maxOccurs="1" />
xsd:element name="quantity" type="Integer" maxOccurs="1" />
xsd:element name="con_id" type="Integer" maxOccurs="1" />
<xsd:element name="country" type="country" maxOccurs="1" />
<xsd:element name="contact_name" type="contact_name" maxOccurs="1" />
<xsd:element name="contact_email" type="contact_email" maxOccurs="1" />
<xsd:element name="contact_phone" type=”contact_phone" maxOccurs="1" />
</xsd:sequence>Sample
<?xml version="1" encoding="UTF-8"?><?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="2023-02-02" id="1" version="1.1">
<complex_asset_transfer id="12">
<direction>OUT</direction>
<ib_acct_id>U139838</ib_acct_id>
<contra_broker_info>
<contra_broker_acct_id>221</contra_broker_acct_id>
<country>USA</country>
<contact_name>test test2 test3</contact_name>
<contact_email>test@mail</contact_email>
<contact_phone>78954</contact_phone>
</contra_broker_info>
<con_id>272093</con_id>
<quantity>80</quantity>
</complex_asset_transfer>
</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
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<instr_result_set xmlns="http://www.interactivebrokers.com/fbfb_result_set"
id="88002148" version="1.2" creation_date="2022-03-03-05:00">
<result>
<instr_id>12</instr_id>
<status>PENDING</status>
<ib_instr_id>43080141</ib_instr_id>
<code></code>
<description></description>
</result>
<result>
<instr_id>13</instr_id>
<status>PENDING</status>
<ib_instr_id>43080142</ib_instr_id>
<code></code>
<description></description>
</result>
</instr_result_set>
