Endpoint Parameters
-
Request parameters
Name Type Origin Description AccountKey AccountKey Query-String Account identifier ClientKey ClientKey Query-String Client identifier EventId String Route Corporate action identifier EventStates EventState [] Query-String Specify event states to look into for event. If EventStates are not specified in request then event will be looked into data from EventStates Approved,Confirmed,Preliminary and Withdrawn. IncludeSubAccounts Boolean Query-String Indicate whether to include events from sub-clients. -
Response Parameters
View Response CodesName Type Description AffectedAccounts Integer Number of accounts on which corresponding event is applicable. Available when IncludeSubAccounts is set to true in the request. AnnouncedDate Date Date at which the issuer announced that a corporate action event will occur. AssetType AssetType Asset type BidIntervalRate PriceAndRate Acceptable price increment used for submitting a bid ClaimPeriod DatePeriod Claim period CorporateActionType CorporateActionType Corporate action type DisplayAndFormat InstrumentDisplayAndFormat Instrument additional properties Effective DateAndStatus Date at which an event is officially effective from the issuer's perspective Electable Electable Indicates whether this event is electable ElectionStatus ElectionStatus Election status EligibleHoldings Number Total holding amount, across accounts, eligible for corresponding event. Available when IncludeSubAccounts is set to true in the request. EventId String Corporate action event Id EventIndicators IndicatorDetail [] Event indicators EventState EventState Current state of the event EventStatus EventStatus Event status EventType CodeDescription Type of event Ex DateAndStatus Execution date of event FirstBidIncrementPrice PriceAndRate First bid increment price Holdings Holding [] Client holdings on an event Available when IncludeSubAccounts is set to false in the request. InformationToComply InformationToComply Indicates whether restrictions apply to the event InterestPeriod DatePeriod Period during which the interest rate has been applied LastBidIncrementPrice PriceAndRate Last bid increment price MaxPrice PriceAndRate Maximum or cap price at which a holder can bid, for example on a Dutch auction offer MaxQuantitySought Number Maximum quantity sought MinPrice PriceAndRate Minimum or floor price at which a holder can bid, for example on a Dutch auction offer MinQuantitySought Number Minimum quantity sought Narrative String Event narrative NewBoardLotQuantity Number Quantity of equity that makes up the new board lot NewDenominationQuantity Number New Denomination of the equity following, for example, an increase or decrease in nominal value NumberofDaysAccrued Integer Number of days used for calculating the accrued interest amount Options EventOption [] Event options Record DateAndStatus Record date of event StrikePrice PriceAndRate Strike price TradingSuspended DateAndStatus Date at which trading of a security is suspended as the result of an event Uic Integer Instrument uic UpdatedDateTime UtcDateTime Date and time when this event was last updated. -
Request Example
Request URL
GET /ca/v2/events/875684?AccountKey=2y0tX0m9ZH7MH8HK38qM9g==&ClientKey=5DG7K1P5cqYBZ77tl7Af4w==&EventStates=Approved,Confirmed&IncludeSubAccounts=False -
Response Example
Response body
{ "AnnouncedDate": "2021-02-12T00:00:00Z", "AssetType": "Stock", "BidIntervalRate": { "Currency": "EUR", "Value": 1 }, "ClaimPeriod": { "End": { "Status": "Ongoing" }, "Start": { "Status": "Ongoing" } }, "CorporateActionType": "Voluntary", "DisplayAndFormat": { "Description": "Chargeurs SA", "IsinCode": "FR0000130692", "Symbol": "CRI:xpar" }, "Effective": { "Date": "2021-02-12T00:00:00Z" }, "Electable": "Electable", "ElectionStatus": "PartialElected", "EventId": "9652429", "EventIndicators": [ { "Indicator": "AdditionalBusinessProcess", "Values": [ { "Code": "NPLE", "Description": "The issuer only allows a single option to be selected per designated holding.", "Name": "No Split Election" } ] }, { "Indicator": "Change", "Values": [ { "Code": "BERE", "Description": "Change from bearer into registered form.", "Name": "Bearer to Registered" } ] }, { "Indicator": "Consent", "Values": [ { "Code": "CTRM", "Description": "This is a change in the terms and conditions of the bond.", "Name": "Change in Terms" } ] }, { "Indicator": "Dividend", "Values": [ { "Code": "FINL", "Description": "Payment of a dividend, less the amounts already paid through interim dividends.", "Name": "Final" } ] } ], "EventState": "Preliminary", "EventStatus": "Past", "EventType": { "Code": "DVCA", "Description": "Distribution of cash to shareholders, in proportion to their equity holding. Ordinary dividends are recurring and regular. Shareholder must take cash and may be offered a choice of currency.", "Name": "Cash Dividend" }, "Ex": { "Date": "2021-02-12T00:00:00Z" }, "FirstBidIncrementPrice": { "Currency": "EUR", "Type": "Actual", "Value": 20 }, "Holdings": [ { "AccountId": "123INET", "Amount": 100, "CashReserved": { "Currency": "USD", "Value": 2583.62 }, "ClientId": "906869", "ClientName": "John", "ElectedAmount": 20, "EventId": "9652429", "Options": [ { "ElectedAmount": 20, "ElectedBy": "John", "ElectionType": "Manual", "Instruction": { "Status": "Accepted" }, "OptionId": "1", "Remarks": "Remarks by client..." } ], "OwnerId": "532" } ], "InformationToComply": "RestrictionsMayApply", "InterestPeriod": { "End": { "Status": "Ongoing" }, "Start": { "Status": "Ongoing" } }, "LastBidIncrementPrice": { "Currency": "EUR", "Type": "Actual", "Value": 60 }, "MaxPrice": { "Currency": "EUR", "Type": "Actual", "Value": 60 }, "MaxQuantitySought": 1000, "MinPrice": { "Currency": "EUR", "Type": "Actual", "Value": 5 }, "MinQuantitySought": 4, "Narrative": "ADTXRights issue trading period of rights: ______________ terms: you may apply for _____ new share for every ______ rights held at _________ per share.
ADTX
Client must ensure that they instruct in the multiple/s advised in the notification.
Failure to comply will result in the rejection of instruction/s and client/s will not be notified of the rejection.
Option 1: exercise (receive shares) option 2: oversubscribe (please state the number of additional shares you wish to oversubscribe for).
Option 3: lapse (default) should the client wish to oversubscribe, kindly ensure to exercise full quantity of rights.
Oversubscription may be subject to scaleback based at the account level.
For clients who elect to exercise and oversubscribe, please ensure your account is funded on the same day of instructions submission; failure to do so will result in your instruction being rejected.
Total subscription cost/s including oversubscription will be debited on the next business day after the instruction deadline date.
A potential future resultant entitlement will be booked to a dummy security and may be subject to a proration factor being applied where oversubscription has been elected.
Note that any reduction or change in this position may be a result of this factor.
The final resultant entitlement will be booked on the market identifier upon receipt from agent.
In the case where scaleback of subscription/oversubscription occurs, cost will be refunded without interest as soon as practical upon receipt from the agent.
We will attempt to sell any tradeable rights position left uninstructed or instructed to lapse on the last rights trading date if the value of the client position is worth more than eur 30 or equivalent to the currency of the security.
For non tradeable rights, rights not exercised will be lapsed worthless.
We hereby informs the client that, according to the laws of the country of its incorporation or the laws of the country of residence of its customers and the laws applicable to an issuer of securities which are subject to corporate actions, the client, will decide to participate or not to such corporate actions upon its sole and exclusive discretion and judgment.
The client will bear any detrimental consequence arising out of or connected to such instruction.
For the avoidance of doubt, any information in relation to the corporate actions sent to the client may have been obtained from sources which are not under the bank's control and accordingly, the bank shall not be held responsible for the truth and the accuracy of this information.
Please refer to the prospectus of the event for any further details.Rights issue trading period of rights: ______________ terms: you may apply for _____ new share for every ______ rights held at _________ per share.
", "NewBoardLotQuantity": 20, "NewDenominationQuantity": 100, "NumberofDaysAccrued": 23, "Options": [ { "BidIntervalRate": { "Currency": "EUR", "Value": 1 }, "CashMovements": [ { "CashMovementType": "Credit", "Currency": "USD", "PriceType": "Actual", "SubscriptionPrice": 11.9623 } ], "CashRequired": false, "Deadline": { "Date": "2021-02-23T08:30:00Z" }, "FirstBidIncrementPrice": { "Currency": "EUR", "Type": "Actual", "Value": 20 }, "IsDefault": false, "IsGross": false, "IsTaxable": true, "LastBidIncrementPrice": { "Currency": "EUR", "Type": "Actual", "Value": 60 }, "MarketDeadline": { "Date": "2021-02-22T00:00:00Z" }, "MaxPrice": { "Currency": "EUR", "Type": "Actual", "Value": 60 }, "MinPrice": { "Currency": "EUR", "Type": "Actual", "Value": 5 }, "OptionId": "1", "OptionIndicators": [ { "Indicator": "BidRange", "Values": [ { "Code": "DIVI", "Description": "All values (including minimum and maximum prices) are divisible by the bid interval.", "Name": "Divisible" } ] } ], "OptionType": { "Code": "CASH", "Name": "Cash" }, "Payment": { "Date": "2021-02-12T00:00:00Z" }, "PayoutBreakdown": [ { "Amount": 5.9623, "Component": { "Code": "INTRT", "Description": "Interest", "Name": "Interest" }, "Currency": "USD" }, { "Amount": 6, "Component": { "Code": "LTCG", "Description": "Long term capital gain", "Name": "Long term capital gain" }, "Currency": "USD" } ] }, { "CashRequired": false, "Deadline": { "Date": "2021-02-23T08:30:00Z" }, "IsDefault": true, "IsGross": false, "IsTaxable": true, "NetRate": 0.08, "OptionId": "2", "OptionIndicators": [ { "Indicator": "CertificationBreakdown", "Values": [ { "Code": "DOMI", "Description": "The holder of the security has to certify his domicile.", "Name": "Country of Domicile" } ] } ], "OptionType": { "Code": "SECU", "Description": "Securities Option" }, "Payment": { "Date": "2021-02-12T00:00:00Z" }, "SecurityMovements": [ { "Currency": "AUD", "DisplayAndFormat": { "Description": "Telstra Corp. Ltd", "IsinCode": "AU000000TLS2", "Symbol": "TLS:xasx" }, "SecurityMovementType": "Credit", "Uic": 5081 } ] } ], "Record": { "Status": "Ongoing" }, "StrikePrice": { "Currency": "EUR", "Type": "Actual", "Value": 25 }, "TradingSuspended": { "Status": "Ongoing" }, "Uic": 13126, "UpdatedDateTime": "2021-02-11T15:30:15Z" }
Client must ensure that they instruct in the multiple/s advised in the notification.
Failure to comply will result in the rejection of instruction/s and client/s will not be notified of the rejection.
Option 1: exercise (receive shares) option 2: oversubscribe (please state the number of additional shares you wish to oversubscribe for).
Option 3: lapse (default) should the client wish to oversubscribe, kindly ensure to exercise full quantity of rights.
Oversubscription may be subject to scaleback based at the account level.
For clients who elect to exercise and oversubscribe, please ensure your account is funded on the same day of instructions submission; failure to do so will result in your instruction being rejected.
Total subscription cost/s including oversubscription will be debited on the next business day after the instruction deadline date.
A potential future resultant entitlement will be booked to a dummy security and may be subject to a proration factor being applied where oversubscription has been elected.
Note that any reduction or change in this position may be a result of this factor.
The final resultant entitlement will be booked on the market identifier upon receipt from agent.
In the case where scaleback of subscription/oversubscription occurs, cost will be refunded without interest as soon as practical upon receipt from the agent.
We will attempt to sell any tradeable rights position left uninstructed or instructed to lapse on the last rights trading date if the value of the client position is worth more than eur 30 or equivalent to the currency of the security.
For non tradeable rights, rights not exercised will be lapsed worthless.
We hereby informs the client that, according to the laws of the country of its incorporation or the laws of the country of residence of its customers and the laws applicable to an issuer of securities which are subject to corporate actions, the client, will decide to participate or not to such corporate actions upon its sole and exclusive discretion and judgment.
The client will bear any detrimental consequence arising out of or connected to such instruction.
For the avoidance of doubt, any information in relation to the corporate actions sent to the client may have been obtained from sources which are not under the bank's control and accordingly, the bank shall not be held responsible for the truth and the accuracy of this information.
Please refer to the prospectus of the event for any further details.