fop
https://[domain]/ws/fb/new-request
-
Initiate US Free of Payment (fop) for existing account(s). For US assets only.
-
For international assets, use complex_asset_transfer (International FOP for FA and FD)
-
-
Customer Type: Fully Disclosed, Non-Disclosed and Advisor-Clients.
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
-
Delivery of long US stock positions, US Warrant positions, and Corporate and Municipal Bond positions from another US bank or broker that is a member of the Depository Trust Company (DTC). Requests for FOPs are made to the third-party broker. However, you must notify IBKR of a third-party FOP on the Position Transfers page in Account Management so that your transfer may be properly placed in your account.
-
An FOP deposit is only a notification of incoming securities while an FOP withdrawal actually transfers securities out.
-
Only available for long US Stock positions, US Warrant positions, and Corporate Municipal Bond positions.
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 |
String |
IBKR Account Number of the client account that is initiating the transfer. |
|
non_ib_acct |
String |
Client account number at the third party broker. |
|
broker_id_at_dtc |
Use /getECAEnumerations 'ACATS' for value |
DTC Number of the third party institution. |
|
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 fop request
»Option 1: Using Security ID (either CUSIP or ISIN
XSD
<xsd:complexType name="fop" maxOccurs="unbounded" >
<xsd:sequence>
<xsd:element name="direction" type="direction_type" maxOccurs="1" />
<xsd:element name="ib_acct" type="String" maxOccurs="1" />
<xsd:element name="non_ib_acct" type="String" maxOccurs="1" />
<xsd:element name="broker_id_at_dtc" type="Stringr" maxOccurs="1" />
<xsd:element name="security_id" type=”String" maxOccurs="1" />
<xsd:element name="quantity" type="Integer" maxOccurs="1" />
<xsd:element name="asset_type" type="asset_type" maxOccurs="1" />
<xsd:element name="security_id_type" type="security_id_type" maxOccurs="1" />
<xsd:element name="currency" type="currency_type" 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="2019-01-11" id="2" version="1">
<fop id="2448">
<direction>OUT</direction>
<ib_acct>U199516</ib_acct>
<non_ib_acct>12345678A</non_ib_acct>
<broker_id_at_dtc>0534</broker_id_at_dtc>
<security_id>459200101</security_id>
<quantity>1000</quantity>
<asset_type>STK</asset_type>
<currency>USD</currency>
<security_id_type>ISIN</security_id_type>
</fop></instruction_set>XSD
<xsd:complexType name="fop" maxOccurs="unbounded" >
<xsd:sequence>
<xsd:element name="direction" type="direction_type" maxOccurs="1" />
<xsd:element name="ib_acct" type="String" maxOccurs="1" />
<xsd:element name="non_ib_acct" type="String" maxOccurs="1" />
<xsd:element name="broker_id_at_dtc" type="Stringr" maxOccurs="1" />
<xsd:element name="quantity" type="Integer" maxOccurs="1" />
<xsd:element name="asset_type" type="asset_type" maxOccurs="1" />
<xsd:element name="con_id" type="con_id" maxOccurs="1" />
<xsd:element name="currency" type="currency_type" 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="2019-01-11" id="2" version="1.1">
<fop id="2448">
<direction>OUT</direction>
<ib_acct>U12345</ib_acct>
<non_ib_acct>12345678A</non_ib_acct>
<broker_id_at_dtc>0534</broker_id_at_dtc>
<quantity>1000</quantity>
<asset_type>STK</asset_type>
<currency>USD</currency>
<con_id>111112</con_id>
</fop></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" 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>PENDING</status>
<ib_instr_id>1</ib_instr_id>
<code/>
<description/>
</result>
</instr_result_set>
