Iso20022

RedemptionBulkOrderCancellationRequestV03

setr.002.001.03

Scope An instructing party, for example, an investment manager or its authorised representative, sends the RedemptionBulkOrderCancellationRequest message to the executing party, for example, a transfer agent, to request the cancellation of a previously sent RedemptionBulkOrder instruction. Usage The RedemptionBulkOrderCancellationRequest message is used to either:

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
%% RedemptionBulkOrderCancellationRequestV03 recursion level 0 with max 0
RedemptionBulkOrderCancellationRequestV03 *-- "1..1" MessageIdentification1 : MessageIdentification
RedemptionBulkOrderCancellationRequestV03 *-- "0..1" AdditionalReference3 : PoolReference
RedemptionBulkOrderCancellationRequestV03 *-- "0..1" AdditionalReference3 : PreviousReference
RedemptionBulkOrderCancellationRequestV03 *-- "0..1" InvestmentFundOrder1 : CancellationByReference
RedemptionBulkOrderCancellationRequestV03 *-- "0..1" RedemptionBulkOrderInstruction2 : CancellationByOrderDetails
RedemptionBulkOrderCancellationRequestV03 *-- "0..1" CopyInformation2 : CopyDetails

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

MessageIdentification building block

Reference that uniquely identifies a message from a business application standpoint. Identifies a message by a unique identifier and the date and time when the message was created by the sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MessageIdentification1 recursion level 0 with max 1
class MessageIdentification1{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}

MessageIdentification1 members

Member name Description Data Type / Multiplicity
Identification Identification of the message. IsoMax35Text - Required 1..1
CreationDateTime Date of creation of the message. IsoISODateTime - Required 1..1

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

Member name Description Data Type / Multiplicity
Reference Business reference of a message assigned by the party issuing the message. This reference must be unique amongst all messages of the same name sent by the same party. IsoMax35Text - Required 1..1
ReferenceIssuer Issuer of the reference. IPartyIdentification2Choice - Optional 0..1
MessageName Name of a message. IsoMax35Text - Optional 0..1

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

Member name Description Data Type / Multiplicity
Reference Business reference of a message assigned by the party issuing the message. This reference must be unique amongst all messages of the same name sent by the same party. IsoMax35Text - Required 1..1
ReferenceIssuer Issuer of the reference. IPartyIdentification2Choice - Optional 0..1
MessageName Name of a message. IsoMax35Text - Optional 0..1

CancellationByReference building block

References of the orders to be cancelled. Reference of an order, order cancellation and master reference. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% InvestmentFundOrder1 recursion level 0 with max 1
class InvestmentFundOrder1{
    MasterReference IsoMax35Text
}
InvestmentFundOrder1 *-- "1..0" InvestmentFundOrder5 : OrderReferences
%% InvestmentFundOrder5 recursion level 1 with max 1
class InvestmentFundOrder5{
    OrderReference IsoMax35Text
    ClientReference IsoMax35Text
    CancellationReference IsoMax35Text
}

InvestmentFundOrder1 members

Member name Description Data Type / Multiplicity
MasterReference Reference assigned to a set of orders or trades in order to link them together. IsoMax35Text - Optional 0..1
OrderReferences Reference of an order and order cancellation. InvestmentFundOrder5 - Unknown 1..0

CancellationByOrderDetails building block

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

classDiagram
   direction tb
%% RedemptionBulkOrderInstruction2 recursion level 0 with max 1
RedemptionBulkOrderInstruction2 *-- "1..1" RedemptionBulkOrder3 : BulkOrderDetails
RedemptionBulkOrderInstruction2 *-- "0..10" Intermediary8 : RelatedPartyDetails
RedemptionBulkOrderInstruction2 *-- "0..0" Extension1 : Extension
%% RedemptionBulkOrder3 recursion level 1 with max 1
class RedemptionBulkOrder3{
    MasterReference IsoMax35Text
    OrderDateTime IsoISODateTime
    RequestedFutureTradeDate IsoISODate
    CancellationRight CancellationRight1Code
    ExtendedCancellationRight IsoExtended350Code
    RequestedSettlementCurrency ActiveCurrencyCode
    RequestedNAVCurrency ActiveOrHistoricCurrencyCode
    TotalSettlementAmount IsoActiveCurrencyAndAmount
    CashSettlementDate IsoISODate
}
RedemptionBulkOrder3 *-- "0..1" IPlaceOfTradeIdentification1Choice : PlaceOfTrade
RedemptionBulkOrder3 *-- "0..1" IDateAndDateTimeChoice : ExpiryDateTime
RedemptionBulkOrder3 *-- "1..1" FinancialInstrument10 : FinancialInstrumentDetails
RedemptionBulkOrder3 *-- "1..0" RedemptionOrder5 : IndividualOrderDetails
RedemptionBulkOrder3 *-- "0..1" PaymentTransaction21 : BulkCashSettlementDetails
%% Intermediary8 recursion level 1 with max 1
class Intermediary8{
    OrderOriginatorEligibility OrderOriginatorEligibility1Code
    Role InvestmentFundRole2Code
    ExtendedRole IsoExtended350Code
}
Intermediary8 *-- "1..1" IPartyIdentification2Choice : Identification
Intermediary8 *-- "0..1" Account7 : Account
%% Extension1 recursion level 1 with max 1
class Extension1{
    PlaceAndName IsoMax350Text
    Text IsoMax350Text
}

RedemptionBulkOrderInstruction2 members

Member name Description Data Type / Multiplicity
BulkOrderDetails Common information related to all the orders. RedemptionBulkOrder3 - Required 1..1
RelatedPartyDetails Information about parties related to the transaction. Intermediary8 - Collection 0..10
Extension Additional information that cannot be captured in the structured elements and/or any other specific block. Extension1 - Unknown 0..0

CopyDetails building block

Message is a copy. Information provided when the message is a copy of a previous message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CopyInformation2 recursion level 0 with max 1
class CopyInformation2{
    CopyIndicator IsoYesNoIndicator
}
CopyInformation2 *-- "0..1" BICIdentification1 : OriginalReceiver
%% BICIdentification1 recursion level 1 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}

CopyInformation2 members

Member name Description Data Type / Multiplicity
CopyIndicator Indicates whether the message is a copy. IsoYesNoIndicator - Required 1..1
OriginalReceiver Original receiver of the message, if this message is a copy. BICIdentification1 - Optional 0..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    RedemptionBulkOrderCancellationRequestV03 --|> IOuterRecord : Implements
    RedemptionBulkOrderCancellationRequestV03Document --|> IOuterDocument~RedemptionBulkOrderCancellationRequestV03~ : Implements
    class IOuterDocument~RedemptionBulkOrderCancellationRequestV03~ {
        RedemptionBulkOrderCancellationRequestV03 Message
     }

Document wrapper for serialization

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

classDiagram
    RedemptionBulkOrderCancellationRequestV03Document *-- RedemptionBulkOrderCancellationRequestV03 : 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.002.001.03">
    <RedBlkOrdrCxlReqV03>
        <MsgId>
            <!-- MessageIdentification inner content -->
        </MsgId>
        <PoolRef>
            <!-- PoolReference inner content -->
        </PoolRef>
        <PrvsRef>
            <!-- PreviousReference inner content -->
        </PrvsRef>
        <CxlByRef>
            <!-- CancellationByReference inner content -->
        </CxlByRef>
        <CxlByOrdrDtls>
            <!-- CancellationByOrderDetails inner content -->
        </CxlByOrdrDtls>
        <CpyDtls>
            <!-- CopyDetails inner content -->
        </CpyDtls>
    </RedBlkOrdrCxlReqV03>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_nuu_m9E7Ed-BzquC8wXy7w_-424280902"
  nextVersions="_AaSJFzbLEead9bDRE_1DAQ"
  previousVersion="_nOQIstE7Ed-BzquC8wXy7w_1647966589"
  name="RedemptionBulkOrderCancellationRequestV03"
  definition="Scope&#xD;&#xA;An instructing party, for example, an investment manager or its authorised representative, sends the RedemptionBulkOrderCancellationRequest message to the executing party, for example, a transfer agent, to request the cancellation of a previously sent RedemptionBulkOrder instruction.&#xD;&#xA;Usage&#xD;&#xA;The RedemptionBulkOrderCancellationRequest message is used to either:&#xD;&#xA;- request the cancellation of an entire RedemptionBulkOrder message, that is, all the individual orders that it contained, or,&#xD;&#xA;- request the cancellation of one or more individual orders included in a previously sent RedemptionBulkOrder message. There is no amendment, but a cancellation and re-instruct policy.&#xD;&#xA;There are two ways to use the message.&#xD;&#xA;(1) When the RedemptionBulkOrderCancellationRequest message is used to request the cancellation of an entire RedemptionBulkOrder message, this can be done by either:&#xD;&#xA;- quoting the order references of all the individual orders listed in the RedemptionBulkOrder message, or,&#xD;&#xA;- quoting the details of all the individual orders (this includes the OrderReference) listed in RedemptionBulkOrder message, but this is not recommended.&#xD;&#xA;The message identification of the RedemptionBulkOrder message may also be quoted in PreviousReference.&#xD;&#xA;It is also possible to request the cancellation of an entire RedemptionBulkOrder message by quoting its message identification in PreviousReference, but this is not recommended.&#xD;&#xA;(2) When the RedemptionBulkOrderCancellationRequest message is used to request the cancellation of one or more individual orders, this can be done by either:&#xD;&#xA;- quoting the OrderReference of each individual order listed in the RedemptionOrder message, or,&#xD;&#xA;- quoting the details of each individual order (including the OrderReference) listed in RedemptionOrder message, but this is not recommended.&#xD;&#xA;The message identification of the RedemptionBulkOrder message in which the individual order was conveyed may also be quoted in PreviousReference.&#xD;&#xA;The deadline and acceptance of a cancellation request is subject to a service level agreement (SLA). This cancellation message is a cancellation request. There is no automatic acceptance of the cancellation."
  registrationStatus="Registered"
  messageSet="_wFQdsE2rEeG_I4xRYCA_7g"
  xmlTag="RedBlkOrdrCxlReqV03"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_nu4wltE7Ed-BzquC8wXy7w_-424280456"
    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/BulkOrderDetails/IndividualOrderDetails/InvestmentAccountDetails must be UNKNOWN."
    registrationStatus="Provisionally Registered" />
  <xors
    xmi:id="_nu4wmdE7Ed-BzquC8wXy7w_-1296669663"
    name="CancellationByReferenceOrByOrderDetailsRule"
    definition="Either CancellationByOrderDetails or CancellationByReference may be present, but not both."
    registrationStatus="Provisionally Registered"
    impactedMessageBuildingBlocks="_nu4wk9E7Ed-BzquC8wXy7w_-443474164 _nu4wlNE7Ed-BzquC8wXy7w_-424280858" />
  <messageBuildingBlock
    xmi:id="_nu4wkNE7Ed-BzquC8wXy7w_8328608"
    nextVersions="_AaSJHTbLEead9bDRE_1DAQ"
    name="MessageIdentification"
    definition="Reference that uniquely identifies a message from a business application standpoint."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_nu4wkdE7Ed-BzquC8wXy7w_-424280550"
    nextVersions="_AaSJHzbLEead9bDRE_1DAQ"
    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="_nu4wktE7Ed-BzquC8wXy7w_-424280515"
    nextVersions="_AaSJITbLEead9bDRE_1DAQ"
    name="PreviousReference"
    definition="Reference to a linked message that was previously sent."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PrvsRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_nu4wk9E7Ed-BzquC8wXy7w_-443474164"
    name="CancellationByReference"
    definition="References of the orders to be cancelled."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="CxlByRef"
    complexType="_TSlwKNp-Ed-ak6NoX_4Aeg_-337332402" />
  <messageBuildingBlock
    xmi:id="_nu4wlNE7Ed-BzquC8wXy7w_-424280858"
    name="CancellationByOrderDetails"
    definition="Common information related to all the orders to be cancelled."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="CxlByOrdrDtls"
    complexType="_RO293Np-Ed-ak6NoX_4Aeg_-1015929589" />
  <messageBuildingBlock
    xmi:id="_nu4wldE7Ed-BzquC8wXy7w_-1015929426"
    nextVersions="_AaSJJzbLEead9bDRE_1DAQ"
    name="CopyDetails"
    definition="Message is a copy."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="CpyDtls"
    complexType="_Q7Vk4tp-Ed-ak6NoX_4Aeg_-1918092012" />
  <messageDefinitionIdentifier
    businessArea="setr"
    messageFunctionality="002"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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