set_fee_template

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

Update fee template for existing account.
Customer Type: Fully Disclosed, Non-Disclosed and Advisor-Clients.

Processing Times

Broker-Clients:
- Fee changes submitted before 17:00 ET are processed on the same day and will take effect starting from midnight on the following business day.
Advisor-Clients:
- If the fee is increased or fee type is changed, the client will need to verify/acknowledge the fee increase directly in Account Management/Client Portal.
  - Fee templates acknowledged by the client prior to 5:45PM ET will be processed on the same day.
  - Fee templates acknowledged by the client after 5:45PM ET will be processed on the following business day.
- If the fee is decreased, the fee will be automatically processed (no client acknowledgement is needed).

Request Parameters

Name	Type	Description
account_number	String	IBKR account ID of the advisor/broker client account which the fee template is being updated for.
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
template_name	String	Name of the new fee template being applied. Client Fee templates will need to be made within the IBKR Portal. Details

Name

Type

Description

account_number

String

IBKR account ID of the advisor/broker client account which the fee template is being updated for.

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

template_name

String

Name of the new fee template being applied.

Client Fee templates will need to be made within the IBKR Portal.

Details

XSD

Copy

<xsd:complexType name="set_fee_template" 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="template_name" type="string " 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">
    <set_fee_template id="2450">
        <account_number>U1234567</account_number>
        <template_name> Welcome </template_name>
     </set_fee_template >
</instruction_set>

Response Parameters

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" encoding="UTF-8" standalone="true"?>
<instr_result_set creation_date="2020-04-09-04:00" version="1.2" id="1" 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>