Messages to indicate events related to corporate actions.
Additional fields:
| Name | Type | Description |
|---|---|---|
CANotificationType | CANotificationType | Represents corporate action notification type. Supported types are:
|
| CorporateActionType | CorporateActionType | This field shows the corporate action type .Possible values:
|
| EventId | String | Corporate action event id |
| EventState | EventState | This field shows the status of the corporate action event. Possible values are:
|
| Effective | DateAndStatus | This field the effective date for corporate action event |
| Ex | DateAndStatus | This field shows the ex date for the corporate action event |
| Payment | DateAndStatus | This field shows the date when resulting allocations due to Corporates action events are paid |
| Deadline | DateAndStatus | This field show the client deadline date at option level |
| EventType | CodeDescription | This field gives the name and description of corporates action type |
| Currency | String | This field shows the currency of dividend received |
| ReinvestmentPrice | Decimal | This field shows the reinvestment price |
| GrossPayment | Decimal | This field shows the gross payment received |
SecurityAmount | Decimal | This field shows the amount of security to be received due to Corporate action event |
| EUTaxAmount | Decimal | This field shows the European tax amount |
| ResidencyTax | Decimal | This field shows the Residency tax amount |
| WithholdingTax | Decimal | This field shows the withholding tax amount |
| TotalTax | Decimal | This field shows the total tax amount |
| OutcomeUic | Int | This field shows the uic of resulting security due to corporate action |
| OutcomeSecurity | InstrumentDisplayAndFormat | This field shows the details of the security resulting from corporate action event |
| Amount | Decimal | This field shows the total settled positions of the instrument on which corporate action is applied |
Sample message:
An example for corporate action event message:
// Announcement
{
"AccountId": "79880/100229",
"AccountKey": "suLphWGhWJStl2ZAKs4uMw==",
"ActivityTime": "2022-02-23T12:10:23.950000Z",
"ActivityType": "CorporateActions",
"AssetType": "Stock",
"CANotificationType": "Announcement",
"ClientId": "32155111",
"ClientKey": "O|AQOruxq|xa3lX7MkaR5Q==",
"CorporateActionType": "Voluntary",
"Effective": {
"Date": "2022-03-15"
},
"EventId": "8857172",
"EventState": "Approved",
"EventType": {
"Code": "EXRI",
"Description": "Shareholders can exercise intermediate securities resulting from a distribution. ... instructions.",
"Name": "Call on Intermediate Securities"
},
"Ex": {
"Date": "2022-03-15"
},
"SequenceId": "575329843",
"Uic": 30309
}
// Update
{
"AccountId": "79880/100173",
"AccountKey": "Xd7fcWDaHNRQ3D6OI6HROw==",
"ActivityTime": "2022-02-25T04:39:07.673333Z",
"ActivityType": "CorporateActions",
"AssetType": "Stock",
"CANotificationType": "Update",
"ClientId": "32155104",
"ClientKey": "6ftDrPneWCeGkOCan0J|cA==",
"CorporateActionType": "Voluntary",
"Deadline": {
"Date": "2022-03-17T00:00:00.000000Z"
},
"Effective": {
"Date": "2022-03-15"
},
"EventId": "8857172",
"EventState": "Approved",
"EventType": {
"Code": "EXRI",
"Description": "Shareholders can exercise intermediate securities resulting from a distribution. ... instructions.",
"Name": "Call on Intermediate Securities"
},
"Ex": {
"Date": "2022-03-15"
},
"SequenceId": "575390196",
"Uic": 30309
}
// Payment
{
"AccountId": "79880/101272",
"AccountKey": "agV2fmhnpa|Tptp522Qufw==",
"ActivityTime": "2022-02-17T03:01:15.350000Z",
"ActivityType": "CorporateActions",
"Amount": 2500,
"AssetType": "Stock",
"CANotificationType": "Payment",
"ClientId": "32155294",
"ClientKey": "ZRsWHUEjJqsrzDPAIvegCA==",
"CorporateActionType": "Mandatory",
"Currency": "SGD",
"Deadline": {
"Date": "2022-02-16T00:00:00.000000Z"
},
"EventId": "8856743",
"EventState": "Approved",
"EventType": {
"Code": "SPLR",
"Description": "Decrease in the number of outstanding shares. Equity price and nominal value of shares are increased accordingly.",
"Name": "Reverse Stock Split"
},
"Ex": {
"Date": "2022-02-16"
},
"Payment": {
"Date": "2022-02-16"
},
"SequenceId": "575212977",
"Uic": 26380
}