Iso20022

CorporateActionInstructionCancellationRequestV08

seev.040.001.08

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:

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
%% CorporateActionInstructionCancellationRequestV08 recursion level 0 with max 0
class CorporateActionInstructionCancellationRequestV08{
    ChangeInstructionIndicator IsoYesNoIndicator
}
CorporateActionInstructionCancellationRequestV08 *-- "1..1" DocumentIdentification31 : InstructionIdentification
CorporateActionInstructionCancellationRequestV08 *-- "1..1" CorporateActionGeneralInformation110 : CorporateActionGeneralInformation
CorporateActionInstructionCancellationRequestV08 *-- "1..1" AccountIdentification46 : AccountDetails
CorporateActionInstructionCancellationRequestV08 *-- "1..1" CorporateActionOption120 : CorporateActionInstruction
CorporateActionInstructionCancellationRequestV08 *-- "0..1" ProtectInstruction3 : ProtectInstruction
CorporateActionInstructionCancellationRequestV08 *-- "0..1" SupplementaryData1 : SupplementaryData

Now, we will zero-in one-by-one on each of these building blocks.

ChangeInstructionIndicator building block

When used in a corporate action instruction, indicates that the current instruction is replacing a previous one that was cancelled earlier. When used in a corporate action instruction cancellation request, 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
%% CorporateActionGeneralInformation110 recursion level 0 with max 1
class CorporateActionGeneralInformation110{
    CorporateActionEventIdentification IsoMax35Text
    OfficialCorporateActionEventIdentification IsoMax35Text
}
CorporateActionGeneralInformation110 *-- "1..1" ICorporateActionEventType52Choice : EventType
CorporateActionGeneralInformation110 *-- "0..1" SecurityIdentification19 : FinancialInstrumentIdentification
%% ICorporateActionEventType52Choice recursion level 1 with max 1
%% SecurityIdentification19 recursion level 1 with max 1
class SecurityIdentification19{
    ISIN IsoISINOct2015Identifier
    Description IsoMax140Text
}
SecurityIdentification19 *-- "0..0" OtherIdentification1 : OtherIdentification

CorporateActionGeneralInformation110 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. ICorporateActionEventType52Choice - 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
%% AccountIdentification46 recursion level 0 with max 1
class AccountIdentification46{
    SafekeepingAccount IsoMax35Text
}
AccountIdentification46 *-- "0..1" IPartyIdentification127Choice : AccountOwner
AccountIdentification46 *-- "0..1" ISafekeepingPlaceFormat28Choice : SafekeepingPlace
%% IPartyIdentification127Choice recursion level 1 with max 1
%% ISafekeepingPlaceFormat28Choice recursion level 1 with max 1

AccountIdentification46 members

Member name Description Data Type / Multiplicity
SafekeepingAccount Account where financial instruments are maintained. IsoMax35Text - Required 1..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
%% CorporateActionOption120 recursion level 0 with max 1
CorporateActionOption120 *-- "1..1" IOptionNumber1Choice : OptionNumber
CorporateActionOption120 *-- "1..1" ICorporateActionOption20Choice : OptionType
CorporateActionOption120 *-- "1..1" IQuantity20Choice : InstructedQuantity
%% IOptionNumber1Choice recursion level 1 with max 1
%% ICorporateActionOption20Choice recursion level 1 with max 1
%% IQuantity20Choice recursion level 1 with max 1

CorporateActionOption120 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. ICorporateActionOption20Choice - Required 1..1
InstructedQuantity Quantity of securities to which this instruction applies. IQuantity20Choice - 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

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 CorporateActionInstructionCancellationRequestV08 implementation follows a specific implementaiton pattern. First of all, CorporateActionInstructionCancellationRequestV08 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CorporateActionInstructionCancellationRequestV08Document implements IOuterDocument. Because CorporateActionInstructionCancellationRequestV08 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CorporateActionInstructionCancellationRequestV08.

classDiagram
    class IOuterRecord
    CorporateActionInstructionCancellationRequestV08 --|> IOuterRecord : Implements
    CorporateActionInstructionCancellationRequestV08Document --|> IOuterDocument~CorporateActionInstructionCancellationRequestV08~ : Implements
    class IOuterDocument~CorporateActionInstructionCancellationRequestV08~ {
        CorporateActionInstructionCancellationRequestV08 Message
     }

Document wrapper for serialization

The only real purpose CorporateActionInstructionCancellationRequestV08Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:seev.040.001.08’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CorporateActionInstructionCancellationRequestV08.ToDocument() method. The returned CorporateActionInstructionCancellationRequestV08Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    CorporateActionInstructionCancellationRequestV08Document *-- CorporateActionInstructionCancellationRequestV08 : 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.08">
    <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>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </CorpActnInstrCxlReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_BBQdw7T-EeiTob_PrFFUxA"
  nextVersions="_hptEs-XjEemEj48jhmlA0Q"
  previousVersion="_ynLuv4b4Eea9VrPZgV7UBQ"
  name="CorporateActionInstructionCancellationRequestV08"
  definition="Scope&#xD;&#xA;The CorporateActionInstructionCancellationRequest message is sent by an account owner to an account servicer to request cancellation of a previously sent corporate action election instruction.&#xD;&#xA;Usage&#xD;&#xA;The message may also be used to:&#xD;&#xA;- re-send a message previously sent (the sub-function of the message is Duplicate),&#xD;&#xA;- provide a third party with a copy of a message for information (the sub-function of the message is Copy),&#xD;&#xA;- 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="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="CorpActnInstrCxlReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_BBQdxbT-EeiTob_PrFFUxA"
    nextVersions="_hptEteXjEemEj48jhmlA0Q"
    previousVersion="_ynLuwYb4Eea9VrPZgV7UBQ"
    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="_BBQdx7T-EeiTob_PrFFUxA"
    nextVersions="_hptEt-XjEemEj48jhmlA0Q"
    previousVersion="_ynLuw4b4Eea9VrPZgV7UBQ"
    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" />
  <messageBuildingBlock
    xmi:id="_BBQdybT-EeiTob_PrFFUxA"
    nextVersions="_hptEv-XjEemEj48jhmlA0Q"
    previousVersion="_ynLuxYb4Eea9VrPZgV7UBQ"
    name="ChangeInstructionIndicator"
    definition="When used in a corporate action instruction, indicates that the current instruction is replacing a previous one that was cancelled earlier. When used in a corporate action instruction cancellation request, 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="_BBQdy7T-EeiTob_PrFFUxA"
    nextVersions="_hptEweXjEemEj48jhmlA0Q"
    previousVersion="_ynLux4b4Eea9VrPZgV7UBQ"
    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="_BBQdzbT-EeiTob_PrFFUxA"
    nextVersions="_hptEw-XjEemEj48jhmlA0Q"
    previousVersion="_ynLuyYb4Eea9VrPZgV7UBQ"
    name="CorporateActionGeneralInformation"
    definition="General information about the corporate action event."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CorpActnGnlInf"
    complexType="_KbXw6Yr8EeaNFeVGetd6Xw" />
  <messageBuildingBlock
    xmi:id="_BBQdz7T-EeiTob_PrFFUxA"
    nextVersions="_hptExeXjEemEj48jhmlA0Q"
    previousVersion="_ynLuy4b4Eea9VrPZgV7UBQ"
    name="AccountDetails"
    definition="General information about the safekeeping account and the account owner."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="AcctDtls"
    complexType="_Z0GPE7XDEeiTob_PrFFUxA" />
  <messageBuildingBlock
    xmi:id="_BBQd0bT-EeiTob_PrFFUxA"
    nextVersions="_hptEx-XjEemEj48jhmlA0Q"
    previousVersion="_ynLuzYb4Eea9VrPZgV7UBQ"
    name="CorporateActionInstruction"
    definition="Information about the corporate action option."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CorpActnInstr"
    complexType="_xN1l8UGTEeWqy4niLuXETA" />
  <messageBuildingBlock
    xmi:id="_y3maQbpZEeilsanBGAzy4A"
    nextVersions="_hptEyeXjEemEj48jhmlA0Q"
    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="_BBQd07T-EeiTob_PrFFUxA"
    nextVersions="_hptEy-XjEemEj48jhmlA0Q"
    previousVersion="_ynLuz4b4Eea9VrPZgV7UBQ"
    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="08" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.