cancel_transaction

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

  • Cancel funding request that was previously submitted using DAM Fb, this includes recurring transactions.

    • Only pending transactions can be canceled.

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

Name Type Description

ib_instr_id

String

IB instruction ID of the funding request that needs to be canceled.

reason

String

Reason for canceling the request.

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

XSD

Copy 
<xsd:complexType name="close_account" maxOccurs="unbounded" >
<xsd:sequence>
 <xsd:element name="ib_instr_id" type="string" maxOccurs="1" />
 <xsd:element name="id" type="Non-Negative-Integer " maxOccurs="1" />
 <xsd:element name="reason" 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">
    <cancel_transaction id="2450">
           <ib_instr_id>123456</ib_instr_id>
          <reason>Text</reason>
    </cancel_transaction> 
</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

Copy 
<?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>