setr.015.001.02
Scope The SwitchOrderConfirmation message is sent by an executing party, eg, a transfer agent, to an instruction party, eg, an investment manager or its authorised representative. 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 used to confirm the details of the execution of a SwitchOrder message. Usage The SwitchOrderConfirmation message is sent to confirm that all the legs of the switch have been executed.
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
%% SwitchOrderConfirmationV02 recursion level 0 with max 0
SwitchOrderConfirmationV02 *-- "0..1" AdditionalReference3 : MasterReference
SwitchOrderConfirmationV02 *-- "0..1" AdditionalReference3 : PoolReference
SwitchOrderConfirmationV02 *-- "0..1" AdditionalReference3 : PreviousReference
SwitchOrderConfirmationV02 *-- "1..1" AdditionalReference3 : RelatedReference
SwitchOrderConfirmationV02 *-- "1..1" SwitchExecution3 : SwitchExecutionDetails
SwitchOrderConfirmationV02 *-- "0..10" Intermediary4 : IntermediaryDetails
SwitchOrderConfirmationV02 *-- "0..1" CopyInformation1 : CopyDetails
SwitchOrderConfirmationV02 *-- "0..1" Extension1 : Extension
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
| 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 |
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 |
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
| 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 |
SwitchExecutionDetails building block
Information related to a switch execution. Execution of a switch order. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% SwitchExecution3 recursion level 0 with max 1
class SwitchExecution3{
OrderDateTime IsoISODateTime
DealReference IsoMax35Text
OrderReference IsoMax35Text
TotalRedemptionAmount IsoActiveCurrencyAndAmount
TotalSubscriptionAmount IsoActiveCurrencyAndAmount
AdditionalCashIn IsoActiveCurrencyAndAmount
ResultingCashOut IsoActiveCurrencyAndAmount
}
SwitchExecution3 *-- "1..1" InvestmentAccount13 : InvestmentAccountDetails
SwitchExecution3 *-- "1..0" SwitchRedemptionLegExecution2 : RedemptionLegDetails
SwitchExecution3 *-- "1..0" SwitchSubscriptionLegExecution2 : SubscriptionLegDetails
SwitchExecution3 *-- "0..1" PaymentTransaction14 : CashSettlementDetails
SwitchExecution3 *-- "0..0" ForeignExchangeTerms4 : ForeignExchangeDetails
%% InvestmentAccount13 recursion level 1 with max 1
class InvestmentAccount13{
AccountName IsoMax35Text
AccountDesignation IsoMax35Text
}
InvestmentAccount13 *-- "1..1" AccountIdentification1 : AccountIdentification
InvestmentAccount13 *-- "0..0" IPartyIdentification2Choice : OwnerIdentification
InvestmentAccount13 *-- "0..1" IPartyIdentification2Choice : AccountServicer
%% SwitchRedemptionLegExecution2 recursion level 1 with max 1
class SwitchRedemptionLegExecution2{
LegIdentification IsoMax35Text
LegExecutionIdentification IsoMax35Text
HoldingsRedemptionRate IsoPercentageRate
NetAmount IsoActiveCurrencyAndAmount
GrossAmount IsoActiveCurrencyAndAmount
CumDividendIndicator IsoYesNoIndicator
IncomePreference IncomePreference1Code
Group1Or2Units UKTaxGroupUnitCode
RequestedSettlementCurrency CurrencyCode
RequestedNAVCurrency CurrencyCode
PhysicalDeliveryIndicator IsoYesNoIndicator
}
SwitchRedemptionLegExecution2 *-- "1..1" FinancialInstrument6 : FinancialInstrumentDetails
SwitchRedemptionLegExecution2 *-- "1..1" FinancialInstrumentQuantity1 : UnitsNumber
SwitchRedemptionLegExecution2 *-- "1..1" IDateAndDateTimeChoice : TradeDateTime
SwitchRedemptionLegExecution2 *-- "1..1" UnitPrice5 : PriceDetails
SwitchRedemptionLegExecution2 *-- "0..1" IProfitAndLoss1Choice : InterimProfitAmount
SwitchRedemptionLegExecution2 *-- "0..1" TotalCharges2 : ChargeGeneralDetails
SwitchRedemptionLegExecution2 *-- "0..1" TotalCommissions2 : CommissionGeneralDetails
SwitchRedemptionLegExecution2 *-- "0..1" TotalTaxes2 : TaxGeneralDetails
SwitchRedemptionLegExecution2 *-- "0..1" FundSettlementParameters4 : SettlementAndCustodyDetails
SwitchRedemptionLegExecution2 *-- "0..1" DeliveryParameters3 : PhysicalDeliveryDetails
%% SwitchSubscriptionLegExecution2 recursion level 1 with max 1
class SwitchSubscriptionLegExecution2{
LegIdentification IsoMax35Text
LegExecutionIdentification IsoMax35Text
NetAmount IsoActiveCurrencyAndAmount
GrossAmount IsoActiveCurrencyAndAmount
CumDividendIndicator IsoYesNoIndicator
IncomePreference IncomePreference1Code
RequestedSettlementCurrency CurrencyCode
RequestedNAVCurrency CurrencyCode
PhysicalDeliveryIndicator IsoYesNoIndicator
}
SwitchSubscriptionLegExecution2 *-- "1..1" FinancialInstrument6 : FinancialInstrumentDetails
SwitchSubscriptionLegExecution2 *-- "1..1" FinancialInstrumentQuantity1 : UnitsNumber
SwitchSubscriptionLegExecution2 *-- "1..1" IDateAndDateTimeChoice : TradeDateTime
SwitchSubscriptionLegExecution2 *-- "1..1" UnitPrice5 : PriceDetails
SwitchSubscriptionLegExecution2 *-- "0..1" IProfitAndLoss1Choice : InterimProfitAmount
SwitchSubscriptionLegExecution2 *-- "0..1" TotalCharges2 : ChargeGeneralDetails
SwitchSubscriptionLegExecution2 *-- "0..1" TotalCommissions2 : CommissionGeneralDetails
SwitchSubscriptionLegExecution2 *-- "0..1" TotalTaxes2 : TaxGeneralDetails
SwitchSubscriptionLegExecution2 *-- "0..1" FundSettlementParameters3 : SettlementAndCustodyDetails
SwitchSubscriptionLegExecution2 *-- "0..1" DeliveryParameters3 : PhysicalDeliveryDetails
%% PaymentTransaction14 recursion level 1 with max 1
class PaymentTransaction14{
SettlementAmount IsoActiveCurrencyAndAmount
SettlementDate IsoISODate
}
PaymentTransaction14 *-- "0..1" ICashInOrOut3Choice : CashInOrOutChoice
%% ForeignExchangeTerms4 recursion level 1 with max 1
class ForeignExchangeTerms4{
BuyAmount IsoActiveCurrencyAnd13DecimalAmount
SellAmount IsoActiveCurrencyAndAmount
UnitCurrency CurrencyCode
QuotedCurrency CurrencyCode
ExchangeRate IsoBaseOneRate
QuotationDate IsoISODateTime
}
ForeignExchangeTerms4 *-- "0..1" IPartyIdentification2Choice : QuotingInstitution
SwitchExecution3 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| OrderDateTime | Date and time at which the order was placed by the investor. | IsoISODateTime - Optional 0..1 |
| DealReference | Unique and unambiguous identifier for an order execution, as assigned by a confirming party. | IsoMax35Text - Required 1..1 |
| OrderReference | Unique and unambiguous identifier for an order, as assigned by the instructing party. | IsoMax35Text - Required 1..1 |
| InvestmentAccountDetails | Account between an investor(s) and a fund manager or a fund. The account can contain holdings in any investment fund or investment fund class managed (or distributed) by the fund manager, within the same fund family. | InvestmentAccount13 - Required 1..1 |
| TotalRedemptionAmount | Amount of money used to determine the quantity of investment fund units to be redeemed. | IsoActiveCurrencyAndAmount - Optional 0..1 |
| TotalSubscriptionAmount | Amount of money used to determine the quantity of investment fund units to be subscribed. | IsoActiveCurrencyAndAmount - Optional 0..1 |
| AdditionalCashIn | Additional amount of money paid by the investor in addition to the switch redemption amount. | IsoActiveCurrencyAndAmount - Optional 0..1 |
| ResultingCashOut | Amount of money that results from a switch-out, that is not reinvested in another investment fund, and is repaid to the investor. | IsoActiveCurrencyAndAmount - Optional 0..1 |
| RedemptionLegDetails | Redemption leg of a switch order execution. | SwitchRedemptionLegExecution2 - Unknown 1..0 |
| SubscriptionLegDetails | Subscription leg of a switch order execution. | SwitchSubscriptionLegExecution2 - Unknown 1..0 |
| CashSettlementDetails | Payment transaction resulting from the investment fund order execution. | PaymentTransaction14 - Optional 0..1 |
| ForeignExchangeDetails | Currency exchange related to the execution of an investment fund order. | ForeignExchangeTerms4 - Unknown 0..0 |
IntermediaryDetails building block
Confirmation of the information related to an intermediary. Party that provides services to investors relating to financial products. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Intermediary4 recursion level 0 with max 1
class Intermediary4{
Role IsoMax35Text
}
Intermediary4 *-- "1..1" IPartyIdentification2Choice : Identification
Intermediary4 *-- "0..1" Account2 : Account
%% IPartyIdentification2Choice recursion level 1 with max 1
%% Account2 recursion level 1 with max 1
Account2 *-- "0..1" AccountIdentification1 : Identification
Account2 *-- "1..1" IPartyIdentification2Choice : AccountServicer
Intermediary4 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Identification | Unique and unambiguous identifier of the intermediary. | IPartyIdentification2Choice - Required 1..1 |
| Account | Business relationship between two entities; one entity is the account owner, the other entity is the account servicer. | Account2 - Optional 0..1 |
| Role | Function performed by the intermediary. | IsoMax35Text - Optional 0..1 |
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
%% CopyInformation1 recursion level 0 with max 1
class CopyInformation1{
CopyIndicator IsoYesNoIndicator
}
CopyInformation1 *-- "1..1" BICIdentification1 : OriginalReceiver
%% BICIdentification1 recursion level 1 with max 1
class BICIdentification1{
BIC IsoBICIdentifier
}
CopyInformation1 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 - Required 1..1 |
Extension building block
Additional information that cannot be captured in the structured elements 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
%% Extension1 recursion level 0 with max 1
class Extension1{
PlaceAndName IsoMax350Text
Text IsoMax350Text
}
Extension1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| PlaceAndName | Name qualifying the information provided in the Text field, and place where this information should be inserted. | IsoMax350Text - Required 1..1 |
| Text | Text of the extension. | IsoMax350Text - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the SwitchOrderConfirmationV02 implementation follows a specific implementaiton pattern. First of all, SwitchOrderConfirmationV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SwitchOrderConfirmationV02Document implements IOuterDocument. Because SwitchOrderConfirmationV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SwitchOrderConfirmationV02.
classDiagram
class IOuterRecord
SwitchOrderConfirmationV02 --|> IOuterRecord : Implements
SwitchOrderConfirmationV02Document --|> IOuterDocument~SwitchOrderConfirmationV02~ : Implements
class IOuterDocument~SwitchOrderConfirmationV02~ {
SwitchOrderConfirmationV02 Message
}
Document wrapper for serialization
The only real purpose SwitchOrderConfirmationV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:setr.015.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SwitchOrderConfirmationV02.ToDocument() method. The returned SwitchOrderConfirmationV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
SwitchOrderConfirmationV02Document *-- SwitchOrderConfirmationV02 : 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.015.001.02">
<setr.015.001.02>
<MstrRef>
<!-- MasterReference inner content -->
</MstrRef>
<PoolRef>
<!-- PoolReference inner content -->
</PoolRef>
<PrvsRef>
<!-- PreviousReference inner content -->
</PrvsRef>
<RltdRef>
<!-- RelatedReference inner content -->
</RltdRef>
<SwtchExctnDtls>
<!-- SwitchExecutionDetails inner content -->
</SwtchExctnDtls>
<IntrmyDtls>
<!-- IntermediaryDetails inner content -->
</IntrmyDtls>
<CpyDtls>
<!-- CopyDetails inner content -->
</CpyDtls>
<Xtnsn>
<!-- Extension inner content -->
</Xtnsn>
</setr.015.001.02>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_7TxshtE7Ed-BzquC8wXy7w_-1591679635"
nextVersions="_7t2ZYNE7Ed-BzquC8wXy7w_190731874"
name="SwitchOrderConfirmationV02"
definition="Scope
The SwitchOrderConfirmation message is sent by an executing party, eg, a transfer agent, to an instruction party, eg, an investment manager or its authorised representative. 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 used to confirm the details of the execution of a SwitchOrder message.
Usage
The SwitchOrderConfirmation message is sent to confirm that all the legs of the switch have been executed."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlName="setr.015.001.02"
xmlTag="setr.015.001.02"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_7T7dhdE7Ed-BzquC8wXy7w_-1534421691"
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 SwitchExecutionDetails/InvestmentAccountDetails must be UNKNOWN."
registrationStatus="Provisionally Registered" />
<messageBuildingBlock
xmi:id="_7Txsh9E7Ed-BzquC8wXy7w_433338806"
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="_7TxsiNE7Ed-BzquC8wXy7w_444423035"
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="_7TxsidE7Ed-BzquC8wXy7w_428723166"
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="_7T7dgNE7Ed-BzquC8wXy7w_442574644"
name="RelatedReference"
definition="Reference to a linked message that was previously received."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RltdRef"
complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
<messageBuildingBlock
xmi:id="_7T7dgdE7Ed-BzquC8wXy7w_-1414365507"
name="SwitchExecutionDetails"
definition="Information related to a switch execution."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SwtchExctnDtls"
complexType="_VVkUhdp-Ed-ak6NoX_4Aeg_-1431911896" />
<messageBuildingBlock
xmi:id="_7T7dgtE7Ed-BzquC8wXy7w_1133369220"
name="IntermediaryDetails"
definition="Confirmation of the information related to an intermediary."
registrationStatus="Provisionally Registered"
maxOccurs="10"
minOccurs="0"
xmlTag="IntrmyDtls"
complexType="_U_XbBdp-Ed-ak6NoX_4Aeg_-129041693" />
<messageBuildingBlock
xmi:id="_7T7dg9E7Ed-BzquC8wXy7w_976977118"
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="_RE37Ydp-Ed-ak6NoX_4Aeg_-877911728" />
<messageBuildingBlock
xmi:id="_7T7dhNE7Ed-BzquC8wXy7w_147041061"
name="Extension"
definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="Xtnsn"
complexType="_Q6vvCNp-Ed-ak6NoX_4Aeg_1503007069" />
<messageDefinitionIdentifier
businessArea="setr"
messageFunctionality="015"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.