/cacapi.ext/submit
https://[domain]/ws/cacapi.ext/submit
-
Endpoint is used to support corporate action requests.
-
HTTP Request Type: POST
Available Services
|
Function |
Usage |
|---|---|
|
Submit corporate action election(s) |
|
|
Retrieve corporate action details by corporate action ID. |
|
|
Query list of corporate actions issued within given time range. |
XSD
Copy
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xsd:schema
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.cstools.interactivebrokers.com"
xmlns="http://www.cstools.interactivebrokers.com"
elementFormDefault="qualified" attributeFormDefault="unqualified">
<!-- Needed as reference for customers -->
<xsd:simpleType name="Currency">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="AED"/>
<xsd:enumeration value="ARS"/>
<xsd:enumeration value="ATS"/>
<xsd:enumeration value="AUD"/>
<xsd:enumeration value="BDT"/>
<xsd:enumeration value="BEF"/>
<xsd:enumeration value="BGN"/>
<xsd:enumeration value="BHD"/>
<xsd:enumeration value="BMD"/>
<xsd:enumeration value="BND"/>
<xsd:enumeration value="BOB"/>
<xsd:enumeration value="BRL"/>
<xsd:enumeration value="BRN"/>
<xsd:enumeration value="BSD"/>
<xsd:enumeration value="BWP"/>
<xsd:enumeration value="BZD"/>
<xsd:enumeration value="CAD"/>
<xsd:enumeration value="CHF"/>
<xsd:enumeration value="CLF"/>
<xsd:enumeration value="CLP"/>
<xsd:enumeration value="CNH"/>
<xsd:enumeration value="CNY"/>
<xsd:enumeration value="COP"/>
<xsd:enumeration value="CYP"/>
<xsd:enumeration value="CZK"/>
<xsd:enumeration value="DEM"/>
<xsd:enumeration value="DKK"/>
<xsd:enumeration value="EEK"/>
<xsd:enumeration value="EGP"/>
<xsd:enumeration value="ESP"/>
<xsd:enumeration value="EUR"/>
<xsd:enumeration value="FIM"/>
<xsd:enumeration value="FRF"/>
<xsd:enumeration value="GBP"/>
<xsd:enumeration value="GHC"/>
<xsd:enumeration value="GIP"/>
<xsd:enumeration value="GRD"/>
<xsd:enumeration value="HKD"/>
<xsd:enumeration value="HRK"/>
<xsd:enumeration value="HUF"/>
<xsd:enumeration value="IDR"/>
<xsd:enumeration value="IEP"/>
<xsd:enumeration value="ILR"/>
<xsd:enumeration value="ILS"/>
<xsd:enumeration value="INR"/>
<xsd:enumeration value="ISK"/>
<xsd:enumeration value="ITL"/>
<xsd:enumeration value="JMD"/>
<xsd:enumeration value="JOD"/>
<xsd:enumeration value="JPY"/>
<xsd:enumeration value="KES"/>
<xsd:enumeration value="KRW"/>
<xsd:enumeration value="KWD"/>
<xsd:enumeration value="KYD"/>
<xsd:enumeration value="KZT"/>
<xsd:enumeration value="LBP"/>
<xsd:enumeration value="LKR"/>
<xsd:enumeration value="LTL"/>
<xsd:enumeration value="LUF"/>
<xsd:enumeration value="LVL"/>
<xsd:enumeration value="MAD"/>
<xsd:enumeration value="MKD"/>
<xsd:enumeration value="MTL"/>
<xsd:enumeration value="MUR"/>
<xsd:enumeration value="MWK"/>
<xsd:enumeration value="MXN"/>
<xsd:enumeration value="MYR"/>
<xsd:enumeration value="NGN"/>
<xsd:enumeration value="NLG"/>
<xsd:enumeration value="NOK"/>
<xsd:enumeration value="NPR"/>
<xsd:enumeration value="NZD"/>
<xsd:enumeration value="OMR"/>
<xsd:enumeration value="PAB"/>
<xsd:enumeration value="PEN"/>
<xsd:enumeration value="PGK"/>
<xsd:enumeration value="PHP"/>
<xsd:enumeration value="PKR"/>
<xsd:enumeration value="PLN"/>
<xsd:enumeration value="PLZ"/>
<xsd:enumeration value="PTE"/>
<xsd:enumeration value="QAR"/>
<xsd:enumeration value="ROL"/>
<xsd:enumeration value="RUB"/>
<xsd:enumeration value="RUR"/>
<xsd:enumeration value="SAR"/>
<xsd:enumeration value="SEK"/>
<xsd:enumeration value="SGD"/>
<xsd:enumeration value="SIT"/>
<xsd:enumeration value="SKK"/>
<xsd:enumeration value="THB"/>
<xsd:enumeration value="TND"/>
<xsd:enumeration value="TRL"/>
<xsd:enumeration value="TWD"/>
<xsd:enumeration value="TZS"/>
<xsd:enumeration value="UAH"/>
<xsd:enumeration value="USD"/>
<xsd:enumeration value="UYU"/>
<xsd:enumeration value="VEB"/>
<xsd:enumeration value="VUV"/>
<xsd:enumeration value="XAF"/>
<xsd:enumeration value="XEU"/>
<xsd:enumeration value="XOF"/>
<xsd:enumeration value="YUD"/>
<xsd:enumeration value="ZAR"/>
<xsd:enumeration value="ZMK"/>
<xsd:enumeration value="ZWD"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="ActionType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="ForwardSplit"/>
<xsd:enumeration value="ReverseSplit"/>
<xsd:enumeration value="IssueChange"/>
<xsd:enumeration value="Merger"/>
<xsd:enumeration value="CashDividend"/>
<xsd:enumeration value="StockDividend"/>
<xsd:enumeration value="SpinOff"/>
<xsd:enumeration value="BondMaturity"/>
<xsd:enumeration value="BondConversion"/>
<xsd:enumeration value="TBillMaturity"/>
<xsd:enumeration value="DelistWorthless"/>
<xsd:enumeration value="RightsIssue"/>
<xsd:enumeration value="ForwardSplitIssueChange"/>
<xsd:enumeration value="CouponPayment"/>
<xsd:enumeration value="ContractSplit"/>
<xsd:enumeration value="TenderIssue"/>
<xsd:enumeration value="ConvertibleIssue"/>
<xsd:enumeration value="TenderOffer"/>
<xsd:enumeration value="SubscribeRights"/>
<xsd:enumeration value="DividendRightsIssue"/>
<xsd:enumeration value="GenericVoluntary"/>
<xsd:enumeration value="SharePurchaseIssue"/>
<xsd:enumeration value="CFDTermination"/>
<xsd:enumeration value="ChoiceDividendIssue"/>
<xsd:enumeration value="PartialCallIssue"/>
<xsd:enumeration value="WarrantSubscriptionIssue"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="SubAccountChoice">
<xsd:restriction base="xsd:token">
<xsd:enumeration value="NONE"/>
<xsd:enumeration value="INCLUDE_SUBS"/>
<xsd:enumeration value="SPECIFIED"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="SecurityIdentifierScheme">
<xsd:restriction base="xsd:token">
<xsd:enumeration value="ISIN"/>
<xsd:enumeration value="CUSIP"/>
<xsd:enumeration value="BLOOMBERG"/>
<xsd:enumeration value="IBCONID"/>
<xsd:enumeration value="UNKNOWN"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="CAType">
<xsd:restriction base="xsd:token">
<xsd:enumeration value="MANDATORY"/>
<xsd:enumeration value="VOLUNTARY"/>
<xsd:enumeration value="ALL"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="MessageCode">
<xsd:restriction base="xsd:token">
<xsd:enumeration value="INVALID_QTY"/>
<xsd:enumeration value="EXCEED_AVAILABLE_QTY"/>
<xsd:enumeration value="LT_MINLOT"/>
<xsd:enumeration value="NOT_MULT_MINLOT"/>
<xsd:enumeration value="INCORRECT_ALLOC"/>
<xsd:enumeration value="QTY_GT_MAX_OVERSUBLIMIT"/>
<xsd:enumeration value="PRICE_LT_MINPRICE"/>
<xsd:enumeration value="PRICE_LT_MAXPRICE"/>
<xsd:enumeration value="INVALID_INC_BIDPRICE"/>
<xsd:enumeration value="PI_PRICE_LT_MINPRICE"/>
<xsd:enumeration value="CI_CONVERSION_VAL_LT_MINVAL"/>
<xsd:enumeration value="INVALID_CUSTACCT"/>
<xsd:enumeration value="INVALID_CAID"/>
<xsd:enumeration value="INVALID_OPERATOR"/>
<xsd:enumeration value="ELECTION_DEADLINE_PASSED"/>
<xsd:enumeration value="SAVE_ELECTION_FAILED"/>
<xsd:enumeration value="FA_ACCOUNT_NOT_ALLOWED"/>
<xsd:enumeration value="INVALID_EFFDATE_RANGE"/>
<xsd:enumeration value="INVALID_DEADLINE_DATE_RANGE"/>
<xsd:enumeration value="INSUFFICIENT_FUNDS_FOR_BASICSUBRIGHTS"/>
<xsd:enumeration value="UNABLE_TO_COMPLETE_CREDIT_CHECK"/>
<xsd:enumeration value="UNKNOWN_ERROR"/>
<xsd:enumeration value="QUERY_RESPONSE_FAILED"/>
<xsd:enumeration value="UNEXPECTED_ERROR"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="MessageSeverity">
<xsd:restriction base="xsd:token">
<xsd:enumeration value="INFO"/>
<xsd:enumeration value="WARNING"/>
<xsd:enumeration value="ERROR"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="OperatorTag">
<xsd:restriction base="xsd:token">
<xsd:enumeration value="FIX"/>
<xsd:enumeration value="AM"/>
<xsd:enumeration value="IB"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="Strike">
<xsd:attribute name="price" type="xsd:double" use="optional" />
<xsd:attribute name="currency" type="xsd:string" use="optional" />
</xsd:complexType>
<xsd:complexType name="CAMessage">
<xsd:attribute name="code" type="MessageCode" use="required"/>
<xsd:attribute name="severity" type="MessageSeverity" use="required"/>
<xsd:attribute name="message" type="xsd:string" use="required"/>
<xsd:attribute name="lang" type="xsd:string" use="optional"/>
</xsd:complexType>
<xsd:complexType name="SecurityId">
<xsd:attribute name="idScheme" type="SecurityIdentifierScheme" use="required"/>
<xsd:attribute name="val" type="xsd:string" use="required"/>
</xsd:complexType>
<xsd:complexType name="Money">
<xsd:attribute name="currency" type="Currency" use="required"/>
<xsd:attribute name="amount" type="xsd:double" use="required"/>
</xsd:complexType>
<xsd:complexType name="CashDeliveryType">
<xsd:sequence>
<xsd:element name="Cash" type="Money" minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="Security">
<xsd:sequence>
<xsd:element name="SecurityId" type="SecurityId" minOccurs="0" maxOccurs="5"/>
</xsd:sequence>
<xsd:attribute name="currency" type="Currency" use="required"/>
<xsd:attribute name="symbol" type="xsd:string" use="required"/>
<xsd:attribute name="exchange" type="xsd:string" use="required"/>
<xsd:attribute name="description" type="xsd:string" use="optional"/>
<xsd:attribute name="type" type="xsd:string" use="optional"/>
</xsd:complexType>
<xsd:complexType name="RatioType">
<xsd:attribute name="numerator" type="xsd:integer" use="required"/>
<xsd:attribute name="denominator" type="xsd:integer" use="required"/>
</xsd:complexType>
<xsd:complexType name="AssetDelivery">
<xsd:sequence>
<xsd:element name="Security" type="Security" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Ratio" type="RatioType" minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="ActionDecisionState">
<xsd:restriction base="xsd:token">
<xsd:enumeration value="NEW"/>
<xsd:enumeration value="APPROVED"/>
<xsd:enumeration value="CANCELED"/>
<xsd:enumeration value="ELECTABLE"/>
<xsd:enumeration value="UNKNOWN"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="Election">
<xsd:attribute name="choiceNum" type="xsd:integer" use="required"/>
<xsd:attribute name="qty" type="xsd:long" use="required"/>
<xsd:attribute name="bidPrice" type="xsd:double" use="optional"/>
<xsd:attribute name="committedQty" type="xsd:long" use="optional"/>
<xsd:attribute name="processedQty" type="xsd:long" use="optional"/>
<xsd:attribute name="lastElectedTime" type="xsd:dateTime" use="optional"/>
<xsd:attribute name="lastElectedBy" type="xsd:string" use="optional"/>
<xsd:attribute name="lastElectedByTag" type="OperatorTag" use="optional"/>
</xsd:complexType>
<xsd:complexType name="CAElectionLimit">
<xsd:attribute name="accountId" type="xsd:string" use="required"/>
<xsd:attribute name="maxOversubLimit" type="xsd:long" use="optional"/>
<xsd:attribute name="minSppLimit" type="xsd:long" use="optional"/>
<xsd:attribute name="maxSppLimit" type="xsd:long" use="optional"/>
</xsd:complexType>
<xsd:complexType name="CAChoice">
<xsd:sequence>
<xsd:element name="description" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="number" type="xsd:integer" use="required"/>
<xsd:attribute name="isDefault" type="xsd:boolean" use="required"/>
<xsd:attribute name="choiceType" type="Choice" use="optional"/>
</xsd:complexType>
<xsd:complexType name="CAElection">
<xsd:sequence>
<xsd:element name="Election" type="Election" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="accountId" type="xsd:string" use="required"/>
<xsd:attribute name="ibCAId" type="xsd:long" use="required"/>
</xsd:complexType>
<xsd:complexType name="CAPosition">
<xsd:attribute name="accountId" type="xsd:string" use="required"/>
<xsd:attribute name="position" type="xsd:long" use="required"/>
<xsd:attribute name="positionTime" type="xsd:dateTime" use="required"/>
</xsd:complexType>
<xsd:complexType name="CAAccount">
<xsd:sequence>
<xsd:element name="CAChoice" type="CAChoice" minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="accountId" type="xsd:string" use="required"/>
<xsd:attribute name="ibCAId" type="xsd:long" use="required"/>
</xsd:complexType>
<xsd:complexType name="CorpAction">
<xsd:sequence>
<xsd:element name="OverviewDescription" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="Security" type="Security" minOccurs="1" maxOccurs="1"/>
<xsd:element name="CashDelivery" type="CashDeliveryType" minOccurs="0" maxOccurs="1"/>
<xsd:element name="AssetDelivery" type="AssetDelivery" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="CAChoice" type="CAChoice" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="CAPosition" type="CAPosition" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="CAElection" type="CAElection" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="CAElectionLimit" type="CAElectionLimit" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="VersionDescription" type="VersionDescription" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="CustomerRestriction" type="CustomerRestriction" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Strike" type="Strike" minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="ibCAId" type="xsd:long" use="required" />
<xsd:attribute name="type" type="ActionType" use="required" />
<xsd:attribute name="isVoluntary" type="xsd:boolean" use="required"/>
<xsd:attribute name="effectiveDate" type="xsd:date" use="optional"/>
<xsd:attribute name="recordDate" type="xsd:date" use="optional"/>
<xsd:attribute name="payDate" type="xsd:date" use="optional"/>
<xsd:attribute name="decisionState" type="ActionDecisionState" use="optional"/>
<xsd:attribute name="lastUpdateDecisionTime" type="xsd:dateTime" use="optional"/>
<xsd:attribute name="whenPosted" type="xsd:dateTime" use="optional"/>
<xsd:attribute name="whenCanceled" type="xsd:dateTime" use="optional"/>
<xsd:attribute name="electionStartDate" type="xsd:dateTime" use="optional"/>
<xsd:attribute name="defaultClientDeadline" type="xsd:dateTime" use="optional"/>
<xsd:attribute name="electionQtyMin" type="xsd:long" use="optional"/>
<xsd:attribute name="electionQtyMult" type="xsd:long" use="optional"/>
<xsd:attribute name="currentVersion" type="xsd:long" use="optional"/>
<xsd:attribute name="includesDetails" type="xsd:boolean" use="required"/>
<xsd:attribute name="includesPositions" type="xsd:boolean" use="required"/>
<xsd:attribute name="hasWithdrawalPrivileges" type="xsd:boolean" use="optional"/>
<xsd:attribute name="electionInstructionMinLot" type="xsd:long" use="optional"/>
<xsd:attribute name="minBidPrice" type="xsd:double" use="optional" />
<xsd:attribute name="maxBidPrice" type="xsd:double" use="optional" />
<xsd:attribute name="bidPriceIncrement" type="xsd:double" use="optional" />
<xsd:attribute name="lastElectedTime" type="xsd:dateTime" use="optional"/>
<xsd:attribute name="lastElectedBy" type="xsd:string" use="optional"/>
<xsd:attribute name="lastElectedByTag" type="OperatorTag" use="optional"/>
<xsd:attribute name="earlyDeadline" type="xsd:dateTime" use="optional"/>
<xsd:attribute name="expirationDate" type="xsd:date" use="optional"/>
</xsd:complexType>
<!--
DN - Do Nothing
DA - Dutch Auction
OR - election option Oversubscribe Right
-->
<xsd:simpleType name="Choice">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="DN"/>
<xsd:enumeration value="DA"/>
<xsd:enumeration value="OR"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="VersionDescription">
<xsd:sequence>
<xsd:element name="Description" type="xsd:string" minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="versionNumber" type="xsd:integer" use="required"/>
<xsd:attribute name="whenNotified" type="xsd:dateTime" use="optional"/>
</xsd:complexType>
<xsd:complexType name="CustomerRestriction">
<xsd:attribute name="custacctId" type="xsd:string" use="required"/>
<xsd:attribute name="restrictInform" type="xsd:boolean" use="required"/>
<xsd:attribute name="restrictParticipate" type="xsd:boolean" use="required"/>
</xsd:complexType>
<!-- End objects -->
<xsd:element name="CARequest" >
<xsd:complexType>
<xsd:sequence>
<xsd:element name="ibCAId" type="xsd:long" minOccurs="1" maxOccurs="100"/>
<xsd:element name="accountIds" type="xsd:string" minOccurs="0" maxOccurs="100"/>
</xsd:sequence>
<xsd:attribute name="accountId" type="xsd:string" use="required"/>
<xsd:attribute name="subAccountsChoice" type="SubAccountChoice" use="required"/>
<xsd:attribute name="includeDetails" type="xsd:boolean" use="required"/>
<xsd:attribute name="includePositions" type="xsd:boolean" use="required"/>
<xsd:attribute name="lang" type="xsd:string" use="optional"/>
<xsd:attribute name="requestId" type="xsd:string" use="required"/>
</xsd:complexType>
</xsd:element>
<xsd:element name="CAResponse" >
<xsd:complexType>
<xsd:sequence>
<xsd:element name="CorpAction" type="CorpAction" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="message" type="CAMessage" minOccurs="1" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="successful" type="xsd:boolean" use="required"/>
<xsd:attribute name="requestId" type="xsd:string" use="required"/>
</xsd:complexType>
</xsd:element>
<xsd:element name="CAElectRequest" >
<xsd:complexType>
<xsd:sequence>
<xsd:element name="CAElection" type="CAElection" minOccurs="1" maxOccurs="10"/>
</xsd:sequence>
<xsd:attribute name="lang" type="xsd:string" use="optional"/>
<xsd:attribute name="requestId" type="xsd:string" use="required"/>
</xsd:complexType>
</xsd:element>
<xsd:complexType name="AccountElectionResult">
<xsd:sequence>
<xsd:element name="messages" type="CAMessage" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="accountId" type="xsd:string" use="required"/>
<xsd:attribute name="successful" type="xsd:boolean" use="required"/>
</xsd:complexType>
<xsd:complexType name="CAElectionResult">
<xsd:sequence>
<xsd:element name="CorpAction" type="CorpAction" minOccurs="0" maxOccurs="1"/>
<xsd:element name="AccountElectionResult" type="AccountElectionResult" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="ibCAId" type="xsd:long" use="required"/>
</xsd:complexType>
<xsd:element name="CAElectResponse" >
<xsd:complexType>
<xsd:sequence>
<xsd:element name="CAElectionResult" type="CAElectionResult" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="message" type="CAMessage" minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="successful" type="xsd:boolean" use="required"/>
<xsd:attribute name="requestId" type="xsd:string" use="required"/>
</xsd:complexType>
</xsd:element>
<!-- DEPRECATED Upcoming with no positions but all other details instead -->
<xsd:element name="UpcomingCorporateActionsRequest" >
<xsd:complexType>
<xsd:attribute name="corpActionType" type="CAType" use="required"/>
<xsd:attribute name="accountId" type="xsd:string" use="required"/>
<xsd:attribute name="subAccountsChoice" type="SubAccountChoice" use="required"/>
<xsd:attribute name="lang" type="xsd:string" use="optional"/>
</xsd:complexType>
</xsd:element>
<!-- DEPRECATED Upcoming electable only with positions -->
<xsd:element name="UpcomingElectableActionsPositionsRequest" >
<xsd:complexType>
<xsd:attribute name="accountId" type="xsd:string" use="required"/>
<xsd:attribute name="subAccountsChoice" type="SubAccountChoice" use="required"/>
<xsd:attribute name="lang" type="xsd:string" use="optional"/>
</xsd:complexType>
</xsd:element>
<xsd:element name="CASearchRequest" >
<xsd:complexType>
<xsd:sequence>
<xsd:element name="accountIds" type="xsd:string" minOccurs="0" maxOccurs="100"/>
</xsd:sequence>
<xsd:attribute name="corpActionType" type="CAType" use="required"/>
<xsd:attribute name="accountId" type="xsd:string" use="required"/>
<xsd:attribute name="subAccountsChoice" type="SubAccountChoice" use="required"/>
<xsd:attribute name="fromDate" type="xsd:string" use="required"/>
<xsd:attribute name="toDate" type="xsd:string" use="required"/>
<xsd:attribute name="lang" type="xsd:string" use="optional"/>
<xsd:attribute name="requestId" type="xsd:string" use="required"/>
</xsd:complexType>
</xsd:element>
</xsd:schema>
|
Name |
Value |
Description |
|---|---|---|
|
CSID |
Client Service ID |
Unique identifier issued by Interactive Brokers.
|
|
base64Payload |
Encrypted and signed archive file, containing corporate actions request. |
Encrypted and signed XML file, encoded in base64. Refer to Submitting Files via Web-Servicefor instructions on how to encrypt the files. |
|
username |
The username associated with the account. |
The IBKR username associated with the account. If you do not have the username, use /getAccountDetail to query the username by the Account ID. |
JSON Request
Copy
{
"CSID":"<client-service-id>",
"username":"<userName>",
"base64Payload":"<encrypted and signed archive file, encoded in base64>"
}Sample
Copy
curl -X POST -H "Content-Type: application/json" -d '{"CSID": "31A4BAF62289A9D21577436119674642342C514E251E270EE61C45554F2BCF0D", "username": "prsrv137",
"base64Payload": "hQIMA2Yga03YlXI8O9CGt/OBSFgXstBlZlJiS5t8xxtb5iOtI8ZwBTjZfFh1sDv3t0YYUi+FiJKvP7zSo7zv3GlwKYR+IxIaE4Ww=="}'
https://api.ibkr.com/ws/cacapi.ext/submit|
Name |
Value |
Description |
|---|---|---|
|
isProcessed |
Boolean |
Indicate whether the request has been processed or not. In case request has been processed. true: Indicates the file was successfully submitted to Interactive Brokers. You will receive either Success OR Error fileData section will have account credentials in an encrypted XML file, encoded in base64 false: Indicates the XML format is invalid, incorrect keys are used or encrypt or sign file OR Server is down
|
|
base64Payload |
Encrypted and signed file, containing the response to the corporate actions request. |
|
JSON Response
Copy
{
"isProcessed":"<true|false>",
"base64Payload":"<encrypted response XML, encoded in base64>"
}Sample
Copy
{
"base64Payload" : "hQIMA+zMmOqKbQWNAQ//fb5/wCFaqDqGsLVAv+ErwxY5wJXQMkGzHJ+W9qaWghnPlfxNLvZgXyKuBBnqJmgynTxT+rDGN7R/2X1wOGPL4Ufa+ZW4Rc6+e4UneJjxPfLl
4LgJ8cmPw08ZyDDS0k99ZIhdS+CFDCBnDnohaB/o/XsOkjIfRaI18D7w69ve+kGddBddb6WyoboVfTwxRPZHi6zX3EXUsZwYZOaO4xop1Kwk/4SfjjOwyDmC
Pgge/72Qb+ZeI4v0E1TLtSycje++nycqNjLQzV/6rQdNx+MV8zvg=",
"success" : true
}
