RedemptionMultipleOrderCancellationInstructionV02

setr.005.001.02

Scope The RedemptionMultipleOrderCancellationInstruction message is sent by an instructing party, eg, an investment manager or its authorised representative, to an executing party, eg, a transfer agent. There may be one or more intermediary parties between the instructing party and the executing party. The intermediary party is, for example, an intermediary or a concentrator. This message is sent to cancel a previously sent RedemptionMultipleOrder instruction. Usage The RedemptionMultipleOrderCancellationInstruction message is used to cancel the entire previously sent RedemptionMultipleOrder message and all the individual orders that it contained. There is no amendment, but a cancellation and re-instruct policy. This message must contain the reference of the message to be cancelled. This message may also contain all the details of the message to be cancelled, but this is not recommended. The deadline and acceptance of a cancellation instruction is subject to a service level agreement (SLA). This cancellation message is a cancellation instruction. There is no automatic acceptance of the cancellation instruction. The rejection or acceptance of a cancellation message instruction is made using an OrderCancellationStatusReport message.

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
%% RedemptionMultipleOrderCancellationInstructionV02 recursion level 0 with max 0
RedemptionMultipleOrderCancellationInstructionV02 *-- "0..1" AdditionalReference3 : MasterReference
RedemptionMultipleOrderCancellationInstructionV02 *-- "0..1" AdditionalReference3 : PoolReference
RedemptionMultipleOrderCancellationInstructionV02 *-- "1..1" AdditionalReference3 : PreviousReference
RedemptionMultipleOrderCancellationInstructionV02 *-- "0..1" RedemptionMultipleOrderInstruction1 : OrderToBeCancelled
  

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

MasterReference building block

Reference assigned to a set of orders or trades in order to link them together. References a related message or provides another reference, such as a pool reference, linking a set of messages. The party which issued the related reference may be the Sender of the referenced message or a party other than the Sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AdditionalReference3 recursion level 0 with max 1
class AdditionalReference3{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference3 *-- "0..1" IPartyIdentification2Choice : ReferenceIssuer
%% IPartyIdentification2Choice recursion level 1 with max 1
  

AdditionalReference3 members

PoolReference building block

Collective reference identifying a set of messages. References a related message or provides another reference, such as a pool reference, linking a set of messages. The party which issued the related reference may be the Sender of the referenced message or a party other than the Sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AdditionalReference3 recursion level 0 with max 1
class AdditionalReference3{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference3 *-- "0..1" IPartyIdentification2Choice : ReferenceIssuer
%% IPartyIdentification2Choice recursion level 1 with max 1
  

AdditionalReference3 members

PreviousReference building block

Reference to a linked message that was previously sent. References a related message or provides another reference, such as a pool reference, linking a set of messages. The party which issued the related reference may be the Sender of the referenced message or a party other than the Sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AdditionalReference3 recursion level 0 with max 1
class AdditionalReference3{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference3 *-- "0..1" IPartyIdentification2Choice : ReferenceIssuer
%% IPartyIdentification2Choice recursion level 1 with max 1
  

AdditionalReference3 members

OrderToBeCancelled building block

Common information related to all the orders to be cancelled. Information about a redemption multiple order. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% RedemptionMultipleOrderInstruction1 recursion level 0 with max 1
RedemptionMultipleOrderInstruction1 *-- "1..1" RedemptionMultipleOrder2 : MultipleOrderDetails
RedemptionMultipleOrderInstruction1 *-- "0..10" Intermediary4 : IntermediaryDetails
RedemptionMultipleOrderInstruction1 *-- "0..1" CopyInformation1 : CopyDetails
RedemptionMultipleOrderInstruction1 *-- "0..0" Extension1 : Extension
%% RedemptionMultipleOrder2 recursion level 1 with max 1
class RedemptionMultipleOrder2{
    PlaceOfTrade CountryCode
    OrderDateTime IsoISODateTime
    ExpiryDateTime IsoISODateTime
}
RedemptionMultipleOrder2 *-- "0..1" CancellationRight1 : CancellationRight
RedemptionMultipleOrder2 *-- "1..1" InvestmentAccount13 : InvestmentAccountDetails
RedemptionMultipleOrder2 *-- "0..1" IndividualPerson2 : BeneficiaryDetails
RedemptionMultipleOrder2 *-- "1..0" RedemptionOrder4 : IndividualOrderDetails
RedemptionMultipleOrder2 *-- "0..1" PaymentTransaction15 : BulkCashSettlementDetails
%% Intermediary4 recursion level 1 with max 1
class Intermediary4{
    Role IsoMax35Text
}
Intermediary4 *-- "1..1" IPartyIdentification2Choice : Identification
Intermediary4 *-- "0..1" Account2 : Account
%% CopyInformation1 recursion level 1 with max 1
class CopyInformation1{
    CopyIndicator IsoYesNoIndicator
}
CopyInformation1 *-- "1..1" BICIdentification1 : OriginalReceiver
%% Extension1 recursion level 1 with max 1
class Extension1{
    PlaceAndName IsoMax350Text
    Text IsoMax350Text
}
  

RedemptionMultipleOrderInstruction1 members

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the RedemptionMultipleOrderCancellationInstructionV02 implementation follows a specific implementaiton pattern. First of all, RedemptionMultipleOrderCancellationInstructionV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, RedemptionMultipleOrderCancellationInstructionV02Document implements IOuterDocument. Because RedemptionMultipleOrderCancellationInstructionV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type RedemptionMultipleOrderCancellationInstructionV02.

classDiagram
    class IOuterRecord
    RedemptionMultipleOrderCancellationInstructionV02 --|> IOuterRecord : Implements
    RedemptionMultipleOrderCancellationInstructionV02Document --|> IOuterDocument~RedemptionMultipleOrderCancellationInstructionV02~ : Implements
    class IOuterDocument~RedemptionMultipleOrderCancellationInstructionV02~ {
        RedemptionMultipleOrderCancellationInstructionV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    RedemptionMultipleOrderCancellationInstructionV02Document *-- RedemptionMultipleOrderCancellationInstructionV02 : 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:setr.005.001.02">
    <setr.005.001.02>
        <MstrRef>
            <!-- MasterReference inner content -->
        </MstrRef>
        <PoolRef>
            <!-- PoolReference inner content -->
        </PoolRef>
        <PrvsRef>
            <!-- PreviousReference inner content -->
        </PrvsRef>
        <OrdrToBeCanc>
            <!-- OrderToBeCancelled inner content -->
        </OrdrToBeCanc>
    </setr.005.001.02>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_q0U3iNE7Ed-BzquC8wXy7w_-953271126"
  nextVersions="_soQTS9E7Ed-BzquC8wXy7w_973068169"
  name="RedemptionMultipleOrderCancellationInstructionV02"
  definition="Scope&#xD;&#xA;The RedemptionMultipleOrderCancellationInstruction message is sent by an instructing party, eg, an investment manager or its authorised representative, to an executing party, eg, a transfer agent. There may be one or more intermediary parties between the instructing party and the executing party. The intermediary party is, for example, an intermediary or a concentrator.&#xD;&#xA;This message is sent to cancel a previously sent RedemptionMultipleOrder instruction.&#xD;&#xA;Usage&#xD;&#xA;The RedemptionMultipleOrderCancellationInstruction message is used to cancel the entire previously sent RedemptionMultipleOrder message and all the individual orders that it contained. There is no amendment, but a cancellation and re-instruct policy.&#xD;&#xA;This message must contain the reference of the message to be cancelled. This message may also contain all the details of the message to be cancelled, but this is not recommended.&#xD;&#xA;The deadline and acceptance of a cancellation instruction is subject to a service level agreement (SLA). This cancellation message is a cancellation instruction. There is no automatic acceptance of the cancellation instruction.&#xD;&#xA;The rejection or acceptance of a cancellation message instruction is made using an OrderCancellationStatusReport message."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlName="setr.005.001.02"
  xmlTag="setr.005.001.02"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_q0eogdE7Ed-BzquC8wXy7w_-421321476"
    name="AccountIdentificationRule"
    definition="If this message is linked to an account opening request and the account identification is not yet known then the value of the AccountIdentification element in OrderToBeCancelled/MultipleOrderDetails/InvestmentAccountDetails must be UNKNOWN."
    registrationStatus="Provisionally Registered" />
  <messageBuildingBlock
    xmi:id="_q0U3idE7Ed-BzquC8wXy7w_-202270986"
    name="MasterReference"
    definition="Reference assigned to a set of orders or trades in order to link them together."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="MstrRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_q0U3itE7Ed-BzquC8wXy7w_-204118814"
    name="PoolReference"
    definition="Collective reference identifying a set of messages."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PoolRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_q0U3i9E7Ed-BzquC8wXy7w_-205966292"
    name="PreviousReference"
    definition="Reference to a linked message that was previously sent."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="PrvsRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_q0eogNE7Ed-BzquC8wXy7w_-338206013"
    name="OrderToBeCancelled"
    definition="Common information related to all the orders to be cancelled."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="OrdrToBeCanc"
    complexType="_U2ucZNp-Ed-ak6NoX_4Aeg_67130856" />
  <messageDefinitionIdentifier
    businessArea="setr"
    messageFunctionality="005"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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