Iso20022

CorporateActionInstructionCancellationRequestStatusAdvice002V10

seev.041.002.10

Scope The CorporateActionInstructionCancellationRequestStatusAdvice message is sent by an account servicer to an account owner or its designated agent to report status of a previously received CorporateActionInstructionCancellationRequest message sent by the account owner. This will include the acknowledgement/rejection of a request to cancel an outstanding 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
%% CorporateActionInstructionCancellationRequestStatusAdvice002V10 recursion level 0 with max 0
CorporateActionInstructionCancellationRequestStatusAdvice002V10 *-- "0..1" DocumentIdentification17 : InstructionCancellationRequestIdentification
CorporateActionInstructionCancellationRequestStatusAdvice002V10 *-- "0..1" DocumentIdentification34 : OtherDocumentIdentification
CorporateActionInstructionCancellationRequestStatusAdvice002V10 *-- "1..1" CorporateActionGeneralInformation144 : CorporateActionGeneralInformation
CorporateActionInstructionCancellationRequestStatusAdvice002V10 *-- "1..1" IInstructionCancellationRequestStatus12Choice : InstructionCancellationRequestStatus
CorporateActionInstructionCancellationRequestStatusAdvice002V10 *-- "0..1" CorporateActionOption169 : CorporateActionInstruction
CorporateActionInstructionCancellationRequestStatusAdvice002V10 *-- "0..1" ProtectInstruction8 : ProtectInstruction
CorporateActionInstructionCancellationRequestStatusAdvice002V10 *-- "0..1" CorporateActionNarrative19 : AdditionalInformation
CorporateActionInstructionCancellationRequestStatusAdvice002V10 *-- "0..1" SupplementaryData1 : SupplementaryData

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

InstructionCancellationRequestIdentification building block

Identification of a related instruction cancellation request document. Identifies a document by a unique identification. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% DocumentIdentification17 recursion level 0 with max 1
class DocumentIdentification17{
    Identification IsoRestrictedFINXMax16Text
}

DocumentIdentification17 members

Member name Description Data Type / Multiplicity
Identification Identifies the document. IsoRestrictedFINXMax16Text - Required 1..1

OtherDocumentIdentification building block

Identification of other documents as well as the document number. Identification of a document as well as the document number. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% DocumentIdentification34 recursion level 0 with max 1
DocumentIdentification34 *-- "1..1" IDocumentIdentification4Choice : Identification
DocumentIdentification34 *-- "0..1" IDocumentNumber6Choice : DocumentNumber
%% IDocumentIdentification4Choice recursion level 1 with max 1
%% IDocumentNumber6Choice recursion level 1 with max 1

DocumentIdentification34 members

Member name Description Data Type / Multiplicity
Identification Unique identifier of the document (message) assigned either by the account servicer or the account owner. IDocumentIdentification4Choice - Required 1..1
DocumentNumber Identification of the type of document. IDocumentNumber6Choice - 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
%% CorporateActionGeneralInformation144 recursion level 0 with max 1
class CorporateActionGeneralInformation144{
    CorporateActionEventIdentification IsoRestrictedFINXMax16Text
    OfficialCorporateActionEventIdentification IsoRestrictedFINXMax16Text
    ClassActionNumber IsoRestrictedFINXMax16Text
}
CorporateActionGeneralInformation144 *-- "1..1" ICorporateActionEventType90Choice : EventType
%% ICorporateActionEventType90Choice recursion level 1 with max 1

CorporateActionGeneralInformation144 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. ICorporateActionEventType90Choice - Required 1..1

InstructionCancellationRequestStatus building block

Provides information about the processing status of the instruction cancellation request. Choice between different instruction cancellation request statuses. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IInstructionCancellationRequestStatus12Choice recursion level 0 with max 1

InstructionCancellationRequestStatus12Choice members

Member name Description Data Type / Multiplicity

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
%% CorporateActionOption169 recursion level 0 with max 1
class CorporateActionOption169{
    SafekeepingAccount IsoRestrictedFINXMax35Text
    StatusCashAmount IsoRestrictedFINActiveCurrencyAndAmount
}
CorporateActionOption169 *-- "1..1" IOptionNumber1Choice : OptionNumber
CorporateActionOption169 *-- "1..1" ICorporateActionOption34Choice : OptionType
CorporateActionOption169 *-- "0..1" IOptionFeaturesFormat27Choice : OptionFeatures
CorporateActionOption169 *-- "0..1" IPartyIdentification136Choice : AccountOwner
CorporateActionOption169 *-- "0..1" ICashAccountIdentification6Choice : CashAccount
CorporateActionOption169 *-- "0..1" ISafekeepingPlaceFormat32Choice : SafekeepingPlace
CorporateActionOption169 *-- "0..1" SecurityIdentification20 : FinancialInstrumentIdentification
CorporateActionOption169 *-- "0..1" SignedQuantityFormat8 : TotalEligibleBalance
CorporateActionOption169 *-- "0..1" SignedQuantityFormat8 : InstructedBalance
CorporateActionOption169 *-- "0..1" SignedQuantityFormat8 : UninstructedBalance
CorporateActionOption169 *-- "0..1" IQuantity10Choice : StatusQuantity
%% IOptionNumber1Choice recursion level 1 with max 1
%% ICorporateActionOption34Choice recursion level 1 with max 1
%% IOptionFeaturesFormat27Choice recursion level 1 with max 1
%% IPartyIdentification136Choice recursion level 1 with max 1
%% ICashAccountIdentification6Choice recursion level 1 with max 1
%% ISafekeepingPlaceFormat32Choice recursion level 1 with max 1
%% SecurityIdentification20 recursion level 1 with max 1
class SecurityIdentification20{
    ISIN IsoISINOct2015Identifier
    Description IsoRestrictedFINXMax140Text
}
SecurityIdentification20 *-- "0..0" OtherIdentification2 : OtherIdentification
%% SignedQuantityFormat8 recursion level 1 with max 1
class SignedQuantityFormat8{
    ShortLongPosition ShortLong1Code
}
SignedQuantityFormat8 *-- "1..1" IQuantity21Choice : QuantityChoice
%% SignedQuantityFormat8 recursion level 1 with max 1
class SignedQuantityFormat8{
    ShortLongPosition ShortLong1Code
}
SignedQuantityFormat8 *-- "1..1" IQuantity21Choice : QuantityChoice
%% SignedQuantityFormat8 recursion level 1 with max 1
class SignedQuantityFormat8{
    ShortLongPosition ShortLong1Code
}
SignedQuantityFormat8 *-- "1..1" IQuantity21Choice : QuantityChoice
%% IQuantity10Choice recursion level 1 with max 1

CorporateActionOption169 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. ICorporateActionOption34Choice - Required 1..1
OptionFeatures Specifies the features that may apply to a corporate action option. IOptionFeaturesFormat27Choice - Optional 0..1
AccountOwner Party that owns the account. IPartyIdentification136Choice - Optional 0..1
SafekeepingAccount Account where financial instruments are maintained. IsoRestrictedFINXMax35Text - Optional 0..1
CashAccount Account on which a securities entry is made. ICashAccountIdentification6Choice - Optional 0..1
SafekeepingPlace Location where the financial instruments are/will be safekept. ISafekeepingPlaceFormat32Choice - Optional 0..1
FinancialInstrumentIdentification Identifies the financial instrument. SecurityIdentification20 - Optional 0..1
TotalEligibleBalance Total balance of securities eligible for this corporate action event. The entitlement calculation is based on this balance. SignedQuantityFormat8 - Optional 0..1
InstructedBalance Balance of instructed position. SignedQuantityFormat8 - Optional 0..1
UninstructedBalance Balance of uninstructed position. SignedQuantityFormat8 - Optional 0..1
StatusQuantity Quantity of securities that has been assigned the status indicated. IQuantity10Choice - Optional 0..1
StatusCashAmount Amount of cash subscribed that has been assigned the status indicated. IsoRestrictedFINActiveCurrencyAndAmount - Optional 0..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
%% ProtectInstruction8 recursion level 0 with max 1
class ProtectInstruction8{
    TransactionType ProtectTransactionType3Code
    ProtectTransactionStatus ProtectInstructionStatus4Code
    TransactionIdentification IsoRestrictedFINMax15Text
    ProtectDate IsoISODate
}
ProtectInstruction8 *-- "0..1" IFinancialInstrumentQuantity31Choice : UncoveredProtectQuantity
%% IFinancialInstrumentQuantity31Choice recursion level 1 with max 1

ProtectInstruction8 members

Member name Description Data Type / Multiplicity
TransactionType Indicates whether the instruction is a protect or a cover protect instruction. ProtectTransactionType3Code - Required 1..1
ProtectTransactionStatus Status of the protect transaction. ProtectInstructionStatus4Code - Optional 0..1
TransactionIdentification Unique reference of the protect transaction assigned by the depository and used for cover protect validation. IsoRestrictedFINMax15Text - Optional 0..1
ProtectDate Date at which the protect instruction was created and used for cover protect validation. IsoISODate - Optional 0..1
UncoveredProtectQuantity Remaining quantity of protect instruction which has not been covered. IFinancialInstrumentQuantity31Choice - 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
%% CorporateActionNarrative19 recursion level 0 with max 1
class CorporateActionNarrative19{
    AdditionalText IsoRestrictedFINXMax350Text
    PartyContactNarrative IsoRestrictedFINXMax350Text
}

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

classDiagram
    class IOuterRecord
    CorporateActionInstructionCancellationRequestStatusAdvice002V10 --|> IOuterRecord : Implements
    CorporateActionInstructionCancellationRequestStatusAdvice002V10Document --|> IOuterDocument~CorporateActionInstructionCancellationRequestStatusAdvice002V10~ : Implements
    class IOuterDocument~CorporateActionInstructionCancellationRequestStatusAdvice002V10~ {
        CorporateActionInstructionCancellationRequestStatusAdvice002V10 Message
     }

Document wrapper for serialization

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

classDiagram
    CorporateActionInstructionCancellationRequestStatusAdvice002V10Document *-- CorporateActionInstructionCancellationRequestStatusAdvice002V10 : 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.041.002.10">
    <CorpActnInstrCxlReqStsAdvc>
        <InstrCxlReqId>
            <!-- InstructionCancellationRequestIdentification inner content -->
        </InstrCxlReqId>
        <OthrDocId>
            <!-- OtherDocumentIdentification inner content -->
        </OthrDocId>
        <CorpActnGnlInf>
            <!-- CorporateActionGeneralInformation inner content -->
        </CorpActnGnlInf>
        <InstrCxlReqSts>
            <!-- InstructionCancellationRequestStatus inner content -->
        </InstrCxlReqSts>
        <CorpActnInstr>
            <!-- CorporateActionInstruction inner content -->
        </CorpActnInstr>
        <PrtctInstr>
            <!-- ProtectInstruction inner content -->
        </PrtctInstr>
        <AddtlInf>
            <!-- AdditionalInformation inner content -->
        </AddtlInf>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </CorpActnInstrCxlReqStsAdvc>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_hwRXgwVREeqjd8n6wD9JVw"
  nextVersions="_BHUZwx9QEeuFz_FaCzCLgQ"
  previousVersion="_hf73U_fEEeiNZp_PtLohLw"
  name="CorporateActionInstructionCancellationRequestStatusAdvice002V10"
  definition="Scope&#xD;&#xA;The CorporateActionInstructionCancellationRequestStatusAdvice message is sent by an account servicer to an account owner or its designated agent to report status of a previously received CorporateActionInstructionCancellationRequest message sent by the account owner. This will include the acknowledgement/rejection of a request to cancel an outstanding 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="CorpActnInstrCxlReqStsAdvc"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_hwRXhQVREeqjd8n6wD9JVw"
    name="AdditionalInformationRule"
    definition="All elements in the AdditionalInformation sequence must not contain information that can be provided in a structured field unless bilaterally agreed."
    registrationStatus="Provisionally Registered" />
  <messageBuildingBlock
    xmi:id="_hwRXigVREeqjd8n6wD9JVw"
    name="InstructionCancellationRequestIdentification"
    definition="Identification of a related instruction cancellation request document."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="InstrCxlReqId"
    complexType="_XWm_Otp-Ed-ak6NoX_4Aeg_-1145599038" />
  <messageBuildingBlock
    xmi:id="_hwRXjAVREeqjd8n6wD9JVw"
    name="OtherDocumentIdentification"
    definition="Identification of other documents as well as the document number."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="OthrDocId"
    complexType="_celQqZKQEeWHWpTQn1FFVg" />
  <messageBuildingBlock
    xmi:id="_hwRXjgVREeqjd8n6wD9JVw"
    name="CorporateActionGeneralInformation"
    definition="General information about the corporate action event."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CorpActnGnlInf"
    complexType="_Szi57AVREeqjd8n6wD9JVw" />
  <messageBuildingBlock
    xmi:id="_hwRXkAVREeqjd8n6wD9JVw"
    name="InstructionCancellationRequestStatus"
    definition="Provides information about the processing status of the instruction cancellation request."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="InstrCxlReqSts"
    complexType="_86aSnZwtEeazcsnODTksnQ" />
  <messageBuildingBlock
    xmi:id="_hwRXkgVREeqjd8n6wD9JVw"
    name="CorporateActionInstruction"
    definition="Information about the corporate action option."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="CorpActnInstr"
    complexType="_hwR_8QVREeqjd8n6wD9JVw" />
  <messageBuildingBlock
    xmi:id="_hwRXlAVREeqjd8n6wD9JVw"
    name="ProtectInstruction"
    definition="Provides detailed information on protect and cover protect instructions."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PrtctInstr"
    complexType="_mnkCkf0hEeiKOe8GCUL1Lg" />
  <messageBuildingBlock
    xmi:id="_hwRXlgVREeqjd8n6wD9JVw"
    name="AdditionalInformation"
    definition="Provides additional information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="AddtlInf"
    complexType="_WbKDmNp-Ed-ak6NoX_4Aeg_1685038746" />
  <messageBuildingBlock
    xmi:id="_hwRXmAVREeqjd8n6wD9JVw"
    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="041"
    flavour="002"
    version="10" />
</messageDefinition>

ISO Building Blocks

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