get_withdrawable_cash

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

  • Query available cash for withdrawal for client accounts AND master account.

  • Customer Type: Fully Disclosed, Non-Disclosed and Advisor-Clients.

Name Type Description

account_number

String

IBKR account ID of the advisor/broker client account requesting to pull saved bank instructions 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

currency

USD

HUF

EUR

CZK

GBP

CNH

CAD

DKK

JPY

RUB

HKD

ILS

AUD

NOK

CHF

SGD

MXN

PLN

SEK

ZAR

NZD

 

 

Specify currency.

XSD

Copy 
<xsd:complexType name="get_withdrawable_cash" 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 " maxOccurs="21" />
</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.2">
    <get_withdrawable_cash id="2">
        <account_number>U1234567</account_number>
        <currency>USD</currency>
    </get_withdrawable_cash>
</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.

client_ib_acct_id

String

IBKR account ID of the advisor/broker client account which the withdrawable cash was queried for.  

currency

USD

HUF

EUR

CZK

GBP

CNH

CAD

DKK

JPY

RUB

HKD

ILS

AUD

NOK

CHF

SGD

MXN

PLN

SEK

ZAR

NZD

 

 

Currency which funds are available for withdrawal. 

withdrawable_amount

String

Cash Amount available for withdrawal (assuming margin loan)

 

*Only applicable for Fully-Disclosed and Advisor Clients.

withdrawable_amount_no_borrow

String

Cash Amount available for withdrawal (without margin loan)

 

*Only applicable for Fully-Disclosed and Advisor Clients.

allowed_transfer_amount_to_master

String

Allowed Transfer Amount to Master assuming margin loan.

 

*Only applicable for Non-Disclosed Clients.

allowed_transfer_amount_to_master_no_borrow

String

Allowed Transfer Amount(no_borrow) to Master.

 

*Only applicable for Non-Disclosed Clients.

Sample

Copy
For Fully-Disclosed / Advisor Client (Success)
<?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">
<get_withdrawable_cash_result>
    <instr_id>1</instr_id>
    <status>PROCESSED</status>
    <ib_instr_id>1</ib_instr_id>
       </description>
    <client_ib_acct_id>U1234567</client_ib_acct_id>
    <currency>USD</currency>
    <withdrawable_amount>100000</withdrawable_amount>
    <withdrawable_amount_no_borrow>50000</withdrawable_amount_no_borrow>
    <allowed_transfer_amount_to_master>0.0</allowed_transfer_amount_to_master>
    <allowed_transfer_amount_to_master_no_borrow>0.0</allowed_transfer_amount_to_master_no_borrow>
</get_withdrawable_cash_result>
</instr_result_set>
Copy
Non-Disclosed Client (Success) 
<?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">
<get_withdrawable_cash_result>
    <instr_id>1</instr_id>
    <status>PROCESSED</status>
    <ib_instr_id>1</ib_instr_id>
    <description>No cash to withdraw found for client account/currency U9999999/USD</description>
    <client_ib_acct_id>U9999999</client_ib_acct_id>
    <currency>USD</currency>
    <withdrawable_amount>0</withdrawable_amount>
    <withdrawable_amount_no_borrow>0</withdrawable_amount_no_borrow>
    <allowed_transfer_amount_to_master>6066.77</allowed_transfer_amount_to_master>
      <allowed_transfer_amount_to_master_no_borrow>0.0</allowed_transfer_amount_to_master_no_borrow>
</get_withdrawable_cash_result>
</instr_result_set>