Messages to indicate events related to corporate actions.
Additional Fields
| Name | Type | Description | Available |
|---|---|---|---|
| Amount | Decimal | The total settled positions of the instrument. | When CANotificationType = Payment |
| AssetType | AssetType | Identifies the instrument, together with the Uic. | Always. |
CANotificationType | CANotificationType | Represents corporate action notification type. Supported types are:
| Always. |
| CorporateActionType | CorporateActionType | The corporate action type. Supported types are:
| Always. |
| Currency | String | The currency of dividend received. | When CANotificationType = Payment |
| Deadline.Date | Date | Last day the customer can choose between Stock, or Cash dividend. | When CorporateActionType = Voluntary |
| DisplayAndFormat.Decimals | Int | The resolution in which e.g. a price must be displayed. Positive numbers are represents digits, and negative numbers represent fractions using this formula: 1/(2^x). | When field group "DisplayAndFormat" is requested. |
| DisplayAndFormat.Description | String | Description of instrument (DAX Index - Nov 2023), in English. | When field group "DisplayAndFormat" is requested. |
| DisplayAndFormat.Symbol | String | A combination of letters used to uniquely identify a traded instrument. e.g. ALFEN:xams. | When field group "DisplayAndFormat" is requested. |
| Effective.Date | Date | Date at which an event is officially effective from the issuer's perspective. | |
| EUTaxAmount | Decimal | The amount of EU tax paid. |
|
| EventId | String | Corporate action event id. | Always. |
| EventState | EventState | The corporate action event. Possible values are:
| Always. |
| EventType.Code | String | Code of the CA. You can display the EventType.Description for meaning of the event. Some common codes (see CAEventTypes in the EOD field descriptions for complete list with meaning):
| |
| EventType.Description | String | Describes the type of CA. | |
| EventType.Name | String | Description of the Code. | |
| Ex.Date | Date | Execution date of event. | |
| FeeAmount | Decimal | The fee paid. | When CANotificationType = Payment |
| OutcomeUic | Int | Uic of the OutcomeUic-instrument. | When CANotificationType = Payment |
| Payment.Date | Date | ||
| ReinvestmentPrice | Decimal | Price at which to reinvest. | |
| ResidencyTax | Decimal | The amount of Residency tax paid. | When CANotificationType = Payment |
| TotalTax | Decimal | The total tax paid. | When CANotificationType = Payment |
| Uic | Int | Identifies the instrument, together with the AssetType. | Always |
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
}