seev.040.001.12
Scope The CorporateActionInstructionCancellationRequest message is sent by an account owner to an account servicer to request cancellation of a previously sent corporate action election instruction. 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
%% CorporateActionInstructionCancellationRequestV12 recursion level 0 with max 0
class CorporateActionInstructionCancellationRequestV12{
ChangeInstructionIndicator IsoYesNoIndicator
}
CorporateActionInstructionCancellationRequestV12 *-- "1..1" DocumentIdentification31 : InstructionIdentification
CorporateActionInstructionCancellationRequestV12 *-- "1..1" CorporateActionGeneralInformation155 : CorporateActionGeneralInformation
CorporateActionInstructionCancellationRequestV12 *-- "1..1" AccountIdentification60 : AccountDetails
CorporateActionInstructionCancellationRequestV12 *-- "1..1" CorporateActionOption200 : CorporateActionInstruction
CorporateActionInstructionCancellationRequestV12 *-- "0..1" ProtectInstruction3 : ProtectInstruction
CorporateActionInstructionCancellationRequestV12 *-- "0..1" CorporateActionNarrative10 : AdditionalInformation
CorporateActionInstructionCancellationRequestV12 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
ChangeInstructionIndicator building block
Indicates that cancelled instruction will be replaced by a new corporate action instruction to be sent later. Indicates a “Yes” or “No” type of answer for an element. For comparison, see the ISO20022 official specification This message is declared as YesNoIndicator in the ISO specification. In our implementation, it is represented in source code as IsoYesNoIndicator. Due to global using directives, it is treated as a System.String by the compiler and runtime.
InstructionIdentification building block
Identification of a previously sent instruction document. Identification of a document and type of link. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% DocumentIdentification31 recursion level 0 with max 1
class DocumentIdentification31{
Identification IsoMax35Text
}
DocumentIdentification31 *-- "0..1" IProcessingPosition7Choice : LinkageType
%% IProcessingPosition7Choice recursion level 1 with max 1
DocumentIdentification31 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Identification | Identifies the document. | IsoMax35Text - Required 1..1 |
| LinkageType | Specifies when this document is to be processed relative to another referred document. | IProcessingPosition7Choice - Optional 0..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
%% CorporateActionGeneralInformation155 recursion level 0 with max 1
class CorporateActionGeneralInformation155{
CorporateActionEventIdentification IsoMax35Text
OfficialCorporateActionEventIdentification IsoMax35Text
}
CorporateActionGeneralInformation155 *-- "1..1" ICorporateActionEventType102Choice : EventType
CorporateActionGeneralInformation155 *-- "0..1" SecurityIdentification19 : FinancialInstrumentIdentification
%% ICorporateActionEventType102Choice recursion level 1 with max 1
%% SecurityIdentification19 recursion level 1 with max 1
class SecurityIdentification19{
ISIN IsoISINOct2015Identifier
Description IsoMax140Text
}
SecurityIdentification19 *-- "0..0" OtherIdentification1 : OtherIdentification
CorporateActionGeneralInformation155 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| CorporateActionEventIdentification | Reference assigned by the account servicer to unambiguously identify a corporate action event. | IsoMax35Text - 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. | IsoMax35Text - Optional 0..1 |
| EventType | Type of corporate action event. | ICorporateActionEventType102Choice - Required 1..1 |
| FinancialInstrumentIdentification | Identification of the security concerned by the corporate action. | SecurityIdentification19 - Optional 0..1 |
AccountDetails building block
General information about the safekeeping account and the account owner. Provides account identification information. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% AccountIdentification60 recursion level 0 with max 1
class AccountIdentification60{
SafekeepingAccount IsoMax35Text
BlockChainAddressOrWallet IsoMax140Text
}
AccountIdentification60 *-- "0..1" IPartyIdentification127Choice : AccountOwner
AccountIdentification60 *-- "0..1" ISafekeepingPlaceFormat28Choice : SafekeepingPlace
%% IPartyIdentification127Choice recursion level 1 with max 1
%% ISafekeepingPlaceFormat28Choice recursion level 1 with max 1
AccountIdentification60 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| SafekeepingAccount | Account where financial instruments are maintained. | IsoMax35Text - Optional 0..1 |
| BlockChainAddressOrWallet | Blockchain address or wallet where digital assets are maintained. This is the equivalent of safekeeping account for digital assets. | IsoMax140Text - Optional 0..1 |
| AccountOwner | Party that legally owns the account. | IPartyIdentification127Choice - Optional 0..1 |
| SafekeepingPlace | Location where the financial instruments are/will be safekept. | ISafekeepingPlaceFormat28Choice - Optional 0..1 |
CorporateActionInstruction building block
Information about the corporate action option. Provides information about the corporate action option. For comparison, see the ISO20022 official specification
classDiagram direction tb %% CorporateActionOption200 recursion level 0 with max 1 CorporateActionOption200 *-- "1..1" IOptionNumber1Choice : OptionNumber CorporateActionOption200 *-- "1..1" ICorporateActionOption40Choice : OptionType CorporateActionOption200 *-- "1..1" IQuantity52Choice : InstructedQuantity %% IOptionNumber1Choice recursion level 1 with max 1 %% ICorporateActionOption40Choice recursion level 1 with max 1 %% IQuantity52Choice recursion level 1 with max 1
CorporateActionOption200 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| OptionNumber | Number identifying the available corporate action options. | IOptionNumber1Choice - Required 1..1 |
| OptionType | Specifies the corporate action options available to the account owner. | ICorporateActionOption40Choice - Required 1..1 |
| InstructedQuantity | Quantity of securities to which this instruction applies. | IQuantity52Choice - Required 1..1 |
ProtectInstruction building block
Provides detailed information on protect and cover protect instructions. Provides detailed information on protect and cover protect instructions. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ProtectInstruction3 recursion level 0 with max 1
class ProtectInstruction3{
TransactionType ProtectTransactionType3Code
TransactionIdentification IsoMax15Text
ProtectDate IsoISODate
}
ProtectInstruction3 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| TransactionType | Indicates whether the instruction is a protect or a cover protect instruction. | ProtectTransactionType3Code - Required 1..1 |
| TransactionIdentification | Unique reference of the protect transaction assigned by the depository and used for cover protect validation. | IsoMax15Text - Optional 0..1 |
| ProtectDate | Date at which the protect instruction was created and used for cover protect validation. | IsoISODate - Optional 0..1 |
AdditionalInformation building block
Provides additional information. Provides additional information such as the information conditions. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% CorporateActionNarrative10 recursion level 0 with max 1
class CorporateActionNarrative10{
AdditionalText IsoMax350Text
PartyContactNarrative IsoMax350Text
}
CorporateActionNarrative10 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| AdditionalText | 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. | IsoMax350Text - Unknown 0..0 |
| PartyContactNarrative | Provides additional information regarding the party, for example, the contact unit or person responsible for the transaction identified in the message. | IsoMax350Text - Unknown 0..0 |
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 CorporateActionInstructionCancellationRequestV12 implementation follows a specific implementaiton pattern. First of all, CorporateActionInstructionCancellationRequestV12 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CorporateActionInstructionCancellationRequestV12Document implements IOuterDocument. Because CorporateActionInstructionCancellationRequestV12 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CorporateActionInstructionCancellationRequestV12.
classDiagram
class IOuterRecord
CorporateActionInstructionCancellationRequestV12 --|> IOuterRecord : Implements
CorporateActionInstructionCancellationRequestV12Document --|> IOuterDocument~CorporateActionInstructionCancellationRequestV12~ : Implements
class IOuterDocument~CorporateActionInstructionCancellationRequestV12~ {
CorporateActionInstructionCancellationRequestV12 Message
}
Document wrapper for serialization
The only real purpose CorporateActionInstructionCancellationRequestV12Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:seev.040.001.12’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CorporateActionInstructionCancellationRequestV12.ToDocument() method. The returned CorporateActionInstructionCancellationRequestV12Document value will serialize correctly according to ISO 20022 standards.
classDiagram
CorporateActionInstructionCancellationRequestV12Document *-- CorporateActionInstructionCancellationRequestV12 : 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.040.001.12">
<CorpActnInstrCxlReq>
<ChngInstrInd>
<!-- ChangeInstructionIndicator inner content -->
</ChngInstrInd>
<InstrId>
<!-- InstructionIdentification inner content -->
</InstrId>
<CorpActnGnlInf>
<!-- CorporateActionGeneralInformation inner content -->
</CorpActnGnlInf>
<AcctDtls>
<!-- AccountDetails inner content -->
</AcctDtls>
<CorpActnInstr>
<!-- CorporateActionInstruction inner content -->
</CorpActnInstr>
<PrtctInstr>
<!-- ProtectInstruction inner content -->
</PrtctInstr>
<AddtlInf>
<!-- AdditionalInformation inner content -->
</AddtlInf>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</CorpActnInstrCxlReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_V4gsOTN3Ee2Amemf1A0gtA"
previousVersion="_yg7AMRbHEeyroI8qKgB7Mg"
name="CorporateActionInstructionCancellationRequestV12"
definition="Scope
The CorporateActionInstructionCancellationRequest message is sent by an account owner to an account servicer to request cancellation of a previously sent corporate action election instruction.
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="_fFKlMXbrEeOVgavDmiBLPw"
xmlTag="CorpActnInstrCxlReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_V4gsOzN3Ee2Amemf1A0gtA"
previousVersion="_yg7AMxbHEeyroI8qKgB7Mg"
name="ChangeInstructionIndicatorGuideline"
definition="ChangeInstructionIndicator may only be used if CorporateActionOptionDetails/WithdrawalAllowedIndicator was set to 'false' or '0' (No) in the CorporateActionNotification message previously received and if CorporateActionOptionDetails/ChangeAllowedIndicator was set to 'true' or '1' (Yes) in the CorporateActionNotification message previously received."
registrationStatus="Provisionally Registered" />
<constraint
xmi:id="_V4gsPTN3Ee2Amemf1A0gtA"
previousVersion="_yg7ANRbHEeyroI8qKgB7Mg"
name="CorporateActionEventIdentificationRule"
definition="If the CorporateActionInstruction message was unsolicited (that is, this instruction has not been preceded by a CorporateActionNotification), then, CorporateActionGeneralInformation/CorporateActionEventIdentification must be NONREF."
registrationStatus="Provisionally Registered" />
<constraint
xmi:id="_V4gsPzN3Ee2Amemf1A0gtA"
previousVersion="_yg7ANxbHEeyroI8qKgB7Mg"
name="BeneficialOwnerBreakdownRequestRule "
definition="If CorporateActionInstruction/OptionType/Code value is BOBD (BeneficialOwnerBreakdownRequest), then CorporateActionGeneralInformation/EventType/Code value must be WTRC (Withholding Tax Relief Certification).
(MT565 NVR C8)"
registrationStatus="Provisionally Registered"
expression="<RuleDefinition><ComplexRule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="EqualToValue"><leftOperand>/CorporateActionGeneralInformation/EventType/Code</leftOperand><rightOperand>WithholdingTaxReliefCertification</rightOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="EqualToValue"><leftOperand>/CorporateActionInstruction/OptionType/Code</leftOperand><rightOperand>BeneficialOwnerBreakdownRequest</rightOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>" />
<messageBuildingBlock
xmi:id="_V4gsRzN3Ee2Amemf1A0gtA"
previousVersion="_yg7APxbHEeyroI8qKgB7Mg"
name="ChangeInstructionIndicator"
definition="Indicates that cancelled instruction will be replaced by a new corporate action instruction to be sent later."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="ChngInstrInd"
simpleType="_YXbjA9p-Ed-ak6NoX_4Aeg_-2040117978" />
<messageBuildingBlock
xmi:id="_V4gsSTN3Ee2Amemf1A0gtA"
previousVersion="_yg7AQRbHEeyroI8qKgB7Mg"
name="InstructionIdentification"
definition="Identification of a previously sent instruction document."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="InstrId"
complexType="_e22_UTnXEeWLJsP1cO-amg" />
<messageBuildingBlock
xmi:id="_V4gsSzN3Ee2Amemf1A0gtA"
previousVersion="_yg7AQxbHEeyroI8qKgB7Mg"
name="CorporateActionGeneralInformation"
definition="General information about the corporate action event."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CorpActnGnlInf"
complexType="_a2sQI-5-Eeqc-LCjwLsUVg" />
<messageBuildingBlock
xmi:id="_V4gsTTN3Ee2Amemf1A0gtA"
previousVersion="_yg7ARRbHEeyroI8qKgB7Mg"
name="AccountDetails"
definition="General information about the safekeeping account and the account owner."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="AcctDtls"
complexType="_VJ1ngyLLEeyNSNrMl2zWxg" />
<messageBuildingBlock
xmi:id="_V4gsTzN3Ee2Amemf1A0gtA"
previousVersion="_yg7ARxbHEeyroI8qKgB7Mg"
name="CorporateActionInstruction"
definition="Information about the corporate action option."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CorpActnInstr"
complexType="_TO4KZRuyEeyhRdHRjakS2w" />
<messageBuildingBlock
xmi:id="_V4gsUTN3Ee2Amemf1A0gtA"
previousVersion="_yg7ASRbHEeyroI8qKgB7Mg"
name="ProtectInstruction"
definition="Provides detailed information on protect and cover protect instructions."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PrtctInstr"
complexType="_ohErVrpZEeilsanBGAzy4A" />
<messageBuildingBlock
xmi:id="_KlA9oTQWEe2o-K1dwNg8Gg"
name="AdditionalInformation"
definition="Provides additional information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="AddtlInf"
complexType="_ULXLNNp-Ed-ak6NoX_4Aeg_-1951841609" />
<messageBuildingBlock
xmi:id="_V4gsUzN3Ee2Amemf1A0gtA"
previousVersion="_yg7ASxbHEeyroI8qKgB7Mg"
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="040"
flavour="001"
version="12" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.