seev.039.002.12
Scope The CorporateActionCancellationAdvice message is sent by an account servicer to an account owner or its designated agent to cancel a previously announced corporate action event in case of error from the account servicer or in case of withdrawal by the issuer. Usage The message may also be used to:
- re-send a message previously sent (the sub-function of the message is Duplicate),
- provide a third party with a copy of a message for information (the sub-function of the message is Copy),
- re-send to a third party a copy of a message for information (the sub-function of the message is Copy Duplicate), using the relevant elements in the business application header (BAH).
Message Construction
Every ISO20022 message has at the highest level what we call ‘building blocks’. Because the message is constructed as immutable records, the association is by composition. Below you can see the relationship between the message and its constituent building blocks: For comparison, see the ISO20022 official specification
classDiagram direction LR %% CorporateActionCancellationAdvice002V12 recursion level 0 with max 0 class CorporateActionCancellationAdvice002V12{ AdditionalText IsoRestrictedFINZMax8000Text } CorporateActionCancellationAdvice002V12 *-- "1..1" CorporateActionCancellation4 : CancellationAdviceGeneralInformation CorporateActionCancellationAdvice002V12 *-- "1..1" CorporateActionGeneralInformation143 : CorporateActionGeneralInformation CorporateActionCancellationAdvice002V12 *-- "1..1" IAccountIdentification50Choice : AccountsDetails CorporateActionCancellationAdvice002V12 *-- "0..1" CorporateAction74 : CorporateActionDetails CorporateActionCancellationAdvice002V12 *-- "0..1" IPartyIdentification137Choice : IssuerAgent CorporateActionCancellationAdvice002V12 *-- "0..1" IPartyIdentification137Choice : PayingAgent CorporateActionCancellationAdvice002V12 *-- "0..1" IPartyIdentification137Choice : SubPayingAgent CorporateActionCancellationAdvice002V12 *-- "0..1" IPartyIdentification137Choice : Registrar CorporateActionCancellationAdvice002V12 *-- "0..1" IPartyIdentification137Choice : ResellingAgent CorporateActionCancellationAdvice002V12 *-- "0..1" IPartyIdentification137Choice : PhysicalSecuritiesAgent CorporateActionCancellationAdvice002V12 *-- "0..1" IPartyIdentification137Choice : DropAgent CorporateActionCancellationAdvice002V12 *-- "0..1" IPartyIdentification137Choice : SolicitationAgent CorporateActionCancellationAdvice002V12 *-- "0..1" IPartyIdentification137Choice : InformationAgent CorporateActionCancellationAdvice002V12 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
CancellationAdviceGeneralInformation building block
General information about the event cancellation status and cancellation reason. Corporate action event cancellation status and reason. For comparison, see the ISO20022 official specification
classDiagram direction tb %% CorporateActionCancellation4 recursion level 0 with max 1 class CorporateActionCancellation4{ CancellationReasonCode CorporateActionCancellationReason1Code CancellationReason IsoRestrictedFINXMax140Text } CorporateActionCancellation4 *-- "1..1" CorporateActionEventStatus1 : ProcessingStatus %% CorporateActionEventStatus1 recursion level 1 with max 1 class CorporateActionEventStatus1{ EventCompletenessStatus EventCompletenessStatus1Code EventConfirmationStatus EventConfirmationStatus1Code }
CorporateActionCancellation4 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
CancellationReasonCode | Specifies reasons for cancellation of a corporate action event. | CorporateActionCancellationReason1Code - Required 1..1 |
CancellationReason | Additional information about cancellation of a corporate action event. | IsoRestrictedFINXMax140Text - Optional 0..1 |
ProcessingStatus | Specifies the status of the details of the event. | CorporateActionEventStatus1 - Required 1..1 |
CorporateActionGeneralInformation building block
General information about the corporate action event. General information about the corporate action event. For comparison, see the ISO20022 official specification
classDiagram direction tb %% CorporateActionGeneralInformation143 recursion level 0 with max 1 class CorporateActionGeneralInformation143{ CorporateActionEventIdentification IsoRestrictedFINXMax16Text OfficialCorporateActionEventIdentification IsoRestrictedFINXMax16Text ClassActionNumber IsoRestrictedFINXMax16Text } CorporateActionGeneralInformation143 *-- "1..1" ICorporateActionEventType89Choice : EventType CorporateActionGeneralInformation143 *-- "1..1" ICorporateActionMandatoryVoluntary4Choice : MandatoryVoluntaryEventType CorporateActionGeneralInformation143 *-- "1..1" SecurityIdentification20 : FinancialInstrumentIdentification %% ICorporateActionEventType89Choice recursion level 1 with max 1 %% ICorporateActionMandatoryVoluntary4Choice recursion level 1 with max 1 %% SecurityIdentification20 recursion level 1 with max 1 class SecurityIdentification20{ ISIN IsoISINOct2015Identifier Description IsoRestrictedFINXMax140Text } SecurityIdentification20 *-- "0..0" OtherIdentification2 : OtherIdentification
CorporateActionGeneralInformation143 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
CorporateActionEventIdentification | Reference assigned by the account servicer to unambiguously identify a corporate action event. | IsoRestrictedFINXMax16Text - Required 1..1 |
OfficialCorporateActionEventIdentification | Official and unique reference assigned by the official central body/entity within each market at the beginning of a corporate action event. | IsoRestrictedFINXMax16Text - Optional 0..1 |
ClassActionNumber | Reference assigned by a court to a class action. | IsoRestrictedFINXMax16Text - Optional 0..1 |
EventType | Type of corporate action event. | ICorporateActionEventType89Choice - Required 1..1 |
MandatoryVoluntaryEventType | Specifies whether the event is mandatory, mandatory with options or voluntary. | ICorporateActionMandatoryVoluntary4Choice - Required 1..1 |
FinancialInstrumentIdentification | Identification of the security concerned by the corporate action. | SecurityIdentification20 - Required 1..1 |
AccountsDetails building block
General information about the safekeeping account and the account owner. Choice between all accounts (GENR - General in ISO 15022) or one or more selected accounts. For comparison, see the ISO20022 official specification
classDiagram direction tb %% IAccountIdentification50Choice recursion level 0 with max 1
AccountIdentification50Choice members
Member name | Description | Data Type / Multiplicity |
---|
CorporateActionDetails building block
Information about the corporate action event. Provides information about the corporate action event. For comparison, see the ISO20022 official specification
classDiagram direction tb %% CorporateAction74 recursion level 0 with max 1 CorporateAction74 *-- "0..1" CorporateActionDate89 : DateDetails CorporateAction74 *-- "0..1" ICorporateActionEventStageFormat15Choice : EventStage CorporateAction74 *-- "0..0" IAdditionalBusinessProcessFormat16Choice : AdditionalBusinessProcessIndicator CorporateAction74 *-- "0..1" ILotteryTypeFormat5Choice : LotteryType %% CorporateActionDate89 recursion level 1 with max 1 CorporateActionDate89 *-- "0..1" IDateFormat41Choice : RecordDate CorporateActionDate89 *-- "0..1" IDateFormat41Choice : ExDividendDate %% ICorporateActionEventStageFormat15Choice recursion level 1 with max 1 %% IAdditionalBusinessProcessFormat16Choice recursion level 1 with max 1 %% ILotteryTypeFormat5Choice recursion level 1 with max 1
CorporateAction74 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
DateDetails | Provides information about the dates related to a corporate action event. | CorporateActionDate89 - Optional 0..1 |
EventStage | Stage in the corporate action event life cycle. | ICorporateActionEventStageFormat15Choice - Optional 0..1 |
AdditionalBusinessProcessIndicator | Specifies the type of the additional business process linked to a corporate action event such as a claim compensation or tax refund. | IAdditionalBusinessProcessFormat16Choice - Unknown 0..0 |
LotteryType | Specifies the type of lottery announced. | ILotteryTypeFormat5Choice - Optional 0..1 |
AdditionalText building block
Provides additional information or specifies in more detail the content of a message. This field may only be used when the information to be transmitted, cannot be coded. Specifies a character string with a maximum length of 8000 characters limited to character set Z, that is, a-z A-Z / - ? : ( ) . , ‘ += ! “ % & * < > ; @ # . For comparison, see the ISO20022 official specification This message is declared as RestrictedFINZMax8000Text in the ISO specification. In our implementation, it is represented in source code as IsoRestrictedFINZMax8000Text. Due to global using directives, it is treated as a System.String by the compiler and runtime.
IssuerAgent building block
Party appointed to administer the event on behalf of the issuer company/offeror. The party may be contacted for more information about the event. Choice between different formats for the identification of a party. For comparison, see the ISO20022 official specification
classDiagram direction tb %% IPartyIdentification137Choice recursion level 0 with max 1
PartyIdentification137Choice members
Member name | Description | Data Type / Multiplicity |
---|
PayingAgent building block
Agent (principal or fiscal paying agent) appointed to execute the payment for the corporate action event on behalf of the issuer company/offeror. Choice between different formats for the identification of a party. For comparison, see the ISO20022 official specification
classDiagram direction tb %% IPartyIdentification137Choice recursion level 0 with max 1
PartyIdentification137Choice members
Member name | Description | Data Type / Multiplicity |
---|
SubPayingAgent building block
Sub-agent appointed to execute the payment for the corporate action event on behalf of the issuer company/offeror. Choice between different formats for the identification of a party. For comparison, see the ISO20022 official specification
classDiagram direction tb %% IPartyIdentification137Choice recursion level 0 with max 1
PartyIdentification137Choice members
Member name | Description | Data Type / Multiplicity |
---|
Registrar building block
Party/agent responsible for maintaining the register of a security. Choice between different formats for the identification of a party. For comparison, see the ISO20022 official specification
classDiagram direction tb %% IPartyIdentification137Choice recursion level 0 with max 1
PartyIdentification137Choice members
Member name | Description | Data Type / Multiplicity |
---|
ResellingAgent building block
Broker-dealer responsible for reselling to new investors securities (usually bonds) that have been tendered for purchase by their owner. Choice between different formats for the identification of a party. For comparison, see the ISO20022 official specification
classDiagram direction tb %% IPartyIdentification137Choice recursion level 0 with max 1
PartyIdentification137Choice members
Member name | Description | Data Type / Multiplicity |
---|
PhysicalSecuritiesAgent building block
Trust company, bank or similar financial institution assigned by an issuer to accept presentations of instruments, usually bonds, for transfer and or exchange. Choice between different formats for the identification of a party. For comparison, see the ISO20022 official specification
classDiagram direction tb %% IPartyIdentification137Choice recursion level 0 with max 1
PartyIdentification137Choice members
Member name | Description | Data Type / Multiplicity |
---|
DropAgent building block
Trust company, bank or similar financial institution that acts on behalf of an out-of-town agent or event agent where securities can be delivered in person. Choice between different formats for the identification of a party. For comparison, see the ISO20022 official specification
classDiagram direction tb %% IPartyIdentification137Choice recursion level 0 with max 1
PartyIdentification137Choice members
Member name | Description | Data Type / Multiplicity |
---|
SolicitationAgent building block
Trust company, bank or similar financial institution assigned by an issuer to maintain records of investors and account balances and transactions for the consent of a material change. Choice between different formats for the identification of a party. For comparison, see the ISO20022 official specification
classDiagram direction tb %% IPartyIdentification137Choice recursion level 0 with max 1
PartyIdentification137Choice members
Member name | Description | Data Type / Multiplicity |
---|
InformationAgent building block
Trust company, bank or similar financial institution assigned by an Issuer to provide information and copies of the offering documentation. Choice between different formats for the identification of a party. For comparison, see the ISO20022 official specification
classDiagram direction tb %% IPartyIdentification137Choice recursion level 0 with max 1
PartyIdentification137Choice members
Member name | Description | Data Type / Multiplicity |
---|
SupplementaryData building block
Additional information that can not be captured in the structured fields and/or any other specific block. Additional information that can not be captured in the structured fields and/or any other specific block. For comparison, see the ISO20022 official specification
classDiagram direction tb %% SupplementaryData1 recursion level 0 with max 1 class SupplementaryData1{ PlaceAndName IsoMax350Text } SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope %% IsoSupplementaryDataEnvelope1 recursion level 1 with max 1
SupplementaryData1 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
PlaceAndName | Unambiguous reference to the location where the supplementary data must be inserted in the message instance. In the case of XML, this is expressed by a valid XPath. | IsoMax350Text - Optional 0..1 |
Envelope | Technical element wrapping the supplementary data. | IsoSupplementaryDataEnvelope1 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the CorporateActionCancellationAdvice002V12 implementation follows a specific implementaiton pattern. First of all, CorporateActionCancellationAdvice002V12 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CorporateActionCancellationAdvice002V12Document implements IOuterDocument. Because CorporateActionCancellationAdvice002V12 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CorporateActionCancellationAdvice002V12.
classDiagram class IOuterRecord CorporateActionCancellationAdvice002V12 --|> IOuterRecord : Implements CorporateActionCancellationAdvice002V12Document --|> IOuterDocument~CorporateActionCancellationAdvice002V12~ : Implements class IOuterDocument~CorporateActionCancellationAdvice002V12~ { CorporateActionCancellationAdvice002V12 Message }
Document wrapper for serialization
The only real purpose CorporateActionCancellationAdvice002V12Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:seev.039.002.12’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CorporateActionCancellationAdvice002V12.ToDocument() method. The returned CorporateActionCancellationAdvice002V12Document value will serialize correctly according to ISO 20022 standards.
classDiagram CorporateActionCancellationAdvice002V12Document *-- CorporateActionCancellationAdvice002V12 : Document
Sample of message format
This is an abbreviated version of what the message should look like.
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:seev.039.002.12">
<CorpActnCxlAdvc>
<CxlAdvcGnlInf>
<!-- CancellationAdviceGeneralInformation inner content -->
</CxlAdvcGnlInf>
<CorpActnGnlInf>
<!-- CorporateActionGeneralInformation inner content -->
</CorpActnGnlInf>
<AcctsDtls>
<!-- AccountsDetails inner content -->
</AcctsDtls>
<CorpActnDtls>
<!-- CorporateActionDetails inner content -->
</CorpActnDtls>
<AddtlTxt>
<!-- AdditionalText inner content -->
</AddtlTxt>
<IssrAgt>
<!-- IssuerAgent inner content -->
</IssrAgt>
<PngAgt>
<!-- PayingAgent inner content -->
</PngAgt>
<SubPngAgt>
<!-- SubPayingAgent inner content -->
</SubPngAgt>
<Regar>
<!-- Registrar inner content -->
</Regar>
<RsellngAgt>
<!-- ResellingAgent inner content -->
</RsellngAgt>
<PhysSctiesAgt>
<!-- PhysicalSecuritiesAgent inner content -->
</PhysSctiesAgt>
<DrpAgt>
<!-- DropAgent inner content -->
</DrpAgt>
<SlctnAgt>
<!-- SolicitationAgent inner content -->
</SlctnAgt>
<InfAgt>
<!-- InformationAgent inner content -->
</InfAgt>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</CorpActnCxlAdvc>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_MJAwI199Ee262vCSVgjImg"
previousVersion="_pc_tsTi7Eeydid5dcNPKvg"
name="CorporateActionCancellationAdvice002V12"
definition="Scope
The CorporateActionCancellationAdvice message is sent by an account servicer to an account owner or its designated agent to cancel a previously announced corporate action event in case of error from the account servicer or in case of withdrawal by the issuer.
Usage
The message may also be used to:
- re-send a message previously sent (the sub-function of the message is Duplicate),
- provide a third party with a copy of a message for information (the sub-function of the message is Copy),
- re-send to a third party a copy of a message for information (the sub-function of the message is Copy Duplicate), using the relevant elements in the business application header (BAH)."
registrationStatus="Registered"
messageSet="_kXAaIKS_EeWiN6v48CBCXg"
xmlTag="CorpActnCxlAdvc"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_MJAwJ199Ee262vCSVgjImg"
name="CancellationAdviceGeneralInformation"
definition="General information about the event cancellation status and cancellation reason."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CxlAdvcGnlInf"
complexType="_TdbKmVAeEeO1M--XQMqOtA" />
<messageBuildingBlock
xmi:id="_MJAwKV99Ee262vCSVgjImg"
name="CorporateActionGeneralInformation"
definition="General information about the corporate action event."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CorpActnGnlInf"
complexType="_A0QptwVREeqjd8n6wD9JVw" />
<messageBuildingBlock
xmi:id="_MJAwK199Ee262vCSVgjImg"
name="AccountsDetails"
definition="General information about the safekeeping account and the account owner."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="AcctsDtls"
complexType="_pdA8Hzi7Eeydid5dcNPKvg" />
<messageBuildingBlock
xmi:id="_MJAwLV99Ee262vCSVgjImg"
name="CorporateActionDetails"
definition="Information about the corporate action event."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="CorpActnDtls"
complexType="_MJKijV99Ee262vCSVgjImg" />
<messageBuildingBlock
xmi:id="_MJAwL199Ee262vCSVgjImg"
name="AdditionalText"
definition="Provides additional information or specifies in more detail the content of a message. This field may only be used when the information to be transmitted, cannot be coded."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="AddtlTxt"
simpleType="_XZcQwtp-Ed-ak6NoX_4Aeg_-1877082870" />
<messageBuildingBlock
xmi:id="_MJAwMV99Ee262vCSVgjImg"
name="IssuerAgent"
definition="Party appointed to administer the event on behalf of the issuer company/offeror. The party may be contacted for more information about the event."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="IssrAgt"
complexType="__2ajK_fDEeiNZp_PtLohLw" />
<messageBuildingBlock
xmi:id="_MJAwM199Ee262vCSVgjImg"
name="PayingAgent"
definition="Agent (principal or fiscal paying agent) appointed to execute the payment for the corporate action event on behalf of the issuer company/offeror."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="PngAgt"
complexType="__2ajK_fDEeiNZp_PtLohLw" />
<messageBuildingBlock
xmi:id="_MJAwNV99Ee262vCSVgjImg"
name="SubPayingAgent"
definition="Sub-agent appointed to execute the payment for the corporate action event on behalf of the issuer company/offeror."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="SubPngAgt"
complexType="__2ajK_fDEeiNZp_PtLohLw" />
<messageBuildingBlock
xmi:id="_MJAwN199Ee262vCSVgjImg"
name="Registrar"
definition="Party/agent responsible for maintaining the register of a security."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="Regar"
complexType="__2ajK_fDEeiNZp_PtLohLw" />
<messageBuildingBlock
xmi:id="_MJAwOV99Ee262vCSVgjImg"
name="ResellingAgent"
definition="Broker-dealer responsible for reselling to new investors securities (usually bonds) that have been tendered for purchase by their owner."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="RsellngAgt"
complexType="__2ajK_fDEeiNZp_PtLohLw" />
<messageBuildingBlock
xmi:id="_MJAwO199Ee262vCSVgjImg"
name="PhysicalSecuritiesAgent"
definition="Trust company, bank or similar financial institution assigned by an issuer to accept presentations of instruments, usually bonds, for transfer and or exchange."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PhysSctiesAgt"
complexType="__2ajK_fDEeiNZp_PtLohLw" />
<messageBuildingBlock
xmi:id="_MJAwPV99Ee262vCSVgjImg"
name="DropAgent"
definition="Trust company, bank or similar financial institution that acts on behalf of an out-of-town agent or event agent where securities can be delivered in person."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="DrpAgt"
complexType="__2ajK_fDEeiNZp_PtLohLw" />
<messageBuildingBlock
xmi:id="_MJAwP199Ee262vCSVgjImg"
name="SolicitationAgent"
definition="Trust company, bank or similar financial institution assigned by an issuer to maintain records of investors and account balances and transactions for the consent of a material change."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="SlctnAgt"
complexType="__2ajK_fDEeiNZp_PtLohLw" />
<messageBuildingBlock
xmi:id="_MJAwQV99Ee262vCSVgjImg"
name="InformationAgent"
definition="Trust company, bank or similar financial institution assigned by an Issuer to provide information and copies of the offering documentation."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="InfAgt"
complexType="__2ajK_fDEeiNZp_PtLohLw" />
<messageBuildingBlock
xmi:id="_MJAwQ199Ee262vCSVgjImg"
name="SupplementaryData"
definition="Additional information that can not be captured in the structured fields and/or any other specific block."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="SplmtryData"
complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
<messageDefinitionIdentifier
businessArea="seev"
messageFunctionality="039"
flavour="002"
version="12" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.