SwitchOrderConfirmationCancellationInstructionV01

setr.055.001.01

Scope An executing party, for example, a transfer agent, sends the SwitchOrderConfirmationCancellationInstruction message to the instructing party, for example, an investment manager or its authorised representative to amend a previously sent SwitchOrderConfirmation message. Usage The SwitchOrderConfirmationCancellationInstruction message is used to cancel a previously sent SwitchOrderConfirmation. The amendment indicator element is used to specify whether the switch order confirmation cancellation is to be followed by a switch order confirmation amendment. There are two ways to specify the switch order confirmation cancellation. Either:

• the business references, for example, OrderReference, DealReference, of the switch order confirmation are quoted, or,
• all the details of the switch order confirmation (this includes the OrderReference and DealReference) are quoted, but this is not recommended. The message identification of the SwitchOrderConfirmation message may also be quoted in PreviousReference. It is also possible to instruct the cancellation of the confirmation message by quoting its message identification in PreviousReference, but this is not recommended.

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
%% SwitchOrderConfirmationCancellationInstructionV01 recursion level 0 with max 0
SwitchOrderConfirmationCancellationInstructionV01 *-- "1..1" MessageIdentification1 : MessageIdentification
SwitchOrderConfirmationCancellationInstructionV01 *-- "0..1" AdditionalReference3 : PoolReference
SwitchOrderConfirmationCancellationInstructionV01 *-- "0..1" AdditionalReference3 : PreviousReference
SwitchOrderConfirmationCancellationInstructionV01 *-- "0..1" AdditionalReference3 : RelatedReference
SwitchOrderConfirmationCancellationInstructionV01 *-- "0..1" InvestmentFundOrderExecution1 : CancellationByReference
SwitchOrderConfirmationCancellationInstructionV01 *-- "0..1" SwitchOrderConfirmation1 : CancellationByOrderConfirmationDetails
SwitchOrderConfirmationCancellationInstructionV01 *-- "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

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

RelatedReference building block

Reference to a linked message that was previously received. 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

CancellationByReference building block

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

classDiagram
   direction tb
%% InvestmentFundOrderExecution1 recursion level 0 with max 1
class InvestmentFundOrderExecution1{
    MasterReference IsoMax35Text
    AmendmentIndicator IsoYesNoIndicator
}
InvestmentFundOrderExecution1 *-- "1..0" InvestmentFundOrderExecution2 : OrderReferences
%% InvestmentFundOrderExecution2 recursion level 1 with max 1
class InvestmentFundOrderExecution2{
    OrderReference IsoMax35Text
    ClientReference IsoMax35Text
    DealReference IsoMax35Text
}
  

InvestmentFundOrderExecution1 members

CancellationByOrderConfirmationDetails building block

Common information related to all the switch orders confirmations to be cancelled. Switch order confirmation details. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SwitchOrderConfirmation1 recursion level 0 with max 1
class SwitchOrderConfirmation1{
    AmendmentIndicator IsoYesNoIndicator
}
SwitchOrderConfirmation1 *-- "1..0" SwitchExecution4 : SwitchExecutionDetails
SwitchOrderConfirmation1 *-- "0..0" Extension1 : Extension
%% SwitchExecution4 recursion level 1 with max 1
class SwitchExecution4{
    MasterReference IsoMax35Text
    OrderDateTime IsoISODateTime
    DealReference IsoMax35Text
    OrderReference IsoMax35Text
    ClientReference IsoMax35Text
    TotalRedemptionAmount IsoActiveCurrencyAndAmount
    TotalSubscriptionAmount IsoActiveCurrencyAndAmount
    RequestedFutureTradeDate IsoISODate
    AdditionalCashIn IsoActiveCurrencyAndAmount
    ResultingCashOut IsoActiveCurrencyAndAmount
    SettlementAmount IsoActiveCurrencyAndAmount
    CashSettlementDate IsoISODate
    SettlementMethod DeliveryReceiptType2Code
    BestExecution BestExecution1Code
    FinancialAdvice FinancialAdvice1Code
    NegotiatedTrade NegotiatedTrade1Code
    LateReport LateReport1Code
}
SwitchExecution4 *-- "0..1" InvestmentAccount21 : InvestmentAccountDetails
SwitchExecution4 *-- "0..10" Intermediary9 : RelatedPartyDetails
SwitchExecution4 *-- "1..0" SwitchRedemptionLegExecution3 : RedemptionLegDetails
SwitchExecution4 *-- "1..0" SwitchSubscriptionLegExecution3 : SubscriptionLegDetails
SwitchExecution4 *-- "0..1" PaymentTransaction26 : CashSettlementDetails
SwitchExecution4 *-- "0..0" ForeignExchangeTerms7 : ForeignExchangeDetails
%% Extension1 recursion level 1 with max 1
class Extension1{
    PlaceAndName IsoMax350Text
    Text IsoMax350Text
}
  

SwitchOrderConfirmation1 members

CopyDetails building block

Information provided when the message is a copy of a previous message. 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

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    SwitchOrderConfirmationCancellationInstructionV01 --|> IOuterRecord : Implements
    SwitchOrderConfirmationCancellationInstructionV01Document --|> IOuterDocument~SwitchOrderConfirmationCancellationInstructionV01~ : Implements
    class IOuterDocument~SwitchOrderConfirmationCancellationInstructionV01~ {
        SwitchOrderConfirmationCancellationInstructionV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    SwitchOrderConfirmationCancellationInstructionV01Document *-- SwitchOrderConfirmationCancellationInstructionV01 : 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.055.001.01">
    <SwtchOrdrConfCxlInstrV01>
        <MsgId>
            <!-- MessageIdentification inner content -->
        </MsgId>
        <PoolRef>
            <!-- PoolReference inner content -->
        </PoolRef>
        <PrvsRef>
            <!-- PreviousReference inner content -->
        </PrvsRef>
        <RltdRef>
            <!-- RelatedReference inner content -->
        </RltdRef>
        <CxlByRef>
            <!-- CancellationByReference inner content -->
        </CxlByRef>
        <CxlByOrdrConfDtls>
            <!-- CancellationByOrderConfirmationDetails inner content -->
        </CxlByOrdrConfDtls>
        <CpyDtls>
            <!-- CopyDetails inner content -->
        </CpyDtls>
    </SwtchOrdrConfCxlInstrV01>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_64NK2NE7Ed-BzquC8wXy7w_1641853769"
  nextVersions="_Aab8CzbLEead9bDRE_1DAQ"
  name="SwitchOrderConfirmationCancellationInstructionV01"
  definition="Scope&#xD;&#xA;An executing party, for example, a transfer agent, sends the SwitchOrderConfirmationCancellationInstruction message to the instructing party, for example, an investment manager or its authorised representative to amend a previously sent SwitchOrderConfirmation message.&#xD;&#xA;Usage&#xD;&#xA;The SwitchOrderConfirmationCancellationInstruction message is used to cancel a previously sent SwitchOrderConfirmation.&#xD;&#xA;The amendment indicator element is used to specify whether the switch order confirmation cancellation is to be followed by a switch order confirmation amendment.&#xD;&#xA;There are two ways to specify the switch order confirmation cancellation. Either:&#xD;&#xA;- the business references, for example, OrderReference, DealReference, of the switch order confirmation are quoted, or,&#xD;&#xA;- all the details of the switch order confirmation (this includes the OrderReference and DealReference) are quoted, but this is not recommended.&#xD;&#xA;The message identification of the SwitchOrderConfirmation message may also be quoted in PreviousReference.&#xD;&#xA;It is also possible to instruct the cancellation of the confirmation message by quoting its message identification in PreviousReference, but this is not recommended."
  registrationStatus="Registered"
  messageSet="_wFQdsE2rEeG_I4xRYCA_7g"
  xmlTag="SwtchOrdrConfCxlInstrV01"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_64W71tE7Ed-BzquC8wXy7w_-327008394"
    name="AccountIdentificationRule"
    definition="If the confirmation message was linked to an account opening request and the account identification is not yet known then the value of the AccountIdentification element in CancellationByOrderConfirmationDetails/SwitchExecutionDetails/InvestmentAccountDetails must be UNKNOWN if present."
    registrationStatus="Provisionally Registered" />
  <xors
    xmi:id="_64gs0tE7Ed-BzquC8wXy7w_-327008359"
    name="CancellationByReferenceOrByOrderConfirmationDetailsRule"
    definition="Either CancellationByOrderConfirmationDetails or CancellationByReference may be present, but not both."
    registrationStatus="Provisionally Registered"
    impactedMessageBuildingBlocks="_64W709E7Ed-BzquC8wXy7w_2085142734 _64W71NE7Ed-BzquC8wXy7w_2077756022" />
  <messageBuildingBlock
    xmi:id="_64NK2dE7Ed-BzquC8wXy7w_2085142778"
    nextVersions="_Aab8ETbLEead9bDRE_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="_64W70NE7Ed-BzquC8wXy7w_1790539569"
    nextVersions="_Aab8EzbLEead9bDRE_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="_64W70dE7Ed-BzquC8wXy7w_1790540438"
    nextVersions="_Aab8FTbLEead9bDRE_1DAQ"
    name="PreviousReference"
    definition="Reference to a linked message that was previously sent."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="PrvsRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_64W70tE7Ed-BzquC8wXy7w_1790541008"
    nextVersions="_Aab8FzbLEead9bDRE_1DAQ"
    name="RelatedReference"
    definition="Reference to a linked message that was previously received."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="RltdRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_64W709E7Ed-BzquC8wXy7w_2085142734"
    name="CancellationByReference"
    definition="References of the switch orders to be cancelled."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="CxlByRef"
    complexType="_R60r-dp-Ed-ak6NoX_4Aeg_-571676430" />
  <messageBuildingBlock
    xmi:id="_64W71NE7Ed-BzquC8wXy7w_2077756022"
    name="CancellationByOrderConfirmationDetails"
    definition="Common information related to all the switch orders confirmations to be cancelled."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="CxlByOrdrConfDtls"
    complexType="_RNqrBtp-Ed-ak6NoX_4Aeg_1790539148" />
  <messageBuildingBlock
    xmi:id="_64W71dE7Ed-BzquC8wXy7w_1791462023"
    nextVersions="_Aab8HTbLEead9bDRE_1DAQ"
    name="CopyDetails"
    definition="Information provided when the message is a copy of a previous message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="CpyDtls"
    complexType="_Q7Vk4tp-Ed-ak6NoX_4Aeg_-1918092012" />
  <messageDefinitionIdentifier
    businessArea="setr"
    messageFunctionality="055"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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