setr.004.001.02
Scope The RedemptionMultipleOrder 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 used to instruct the executing party to redeem to one or more financial instruments, for the same account. Usage The RedemptionMultipleOrder message is used for multiple orders. It may also be used for single orders, ie, a message containing one order for one financial instrument and related to one investment account. For a single redemption order, the RedemptionMultipleOrder message, not the RedemptionBulkOrder message, must be used. If there are redemption orders for the same financial instrument but for different accounts, then the RedemptionBulkOrder must be used.
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 %% RedemptionMultipleOrderV02 recursion level 0 with max 0 RedemptionMultipleOrderV02 *-- "0..1" AdditionalReference3 : MasterReference RedemptionMultipleOrderV02 *-- "0..1" AdditionalReference3 : PoolReference RedemptionMultipleOrderV02 *-- "0..1" AdditionalReference3 : PreviousReference RedemptionMultipleOrderV02 *-- "1..1" RedemptionMultipleOrder2 : MultipleOrderDetails RedemptionMultipleOrderV02 *-- "0..10" Intermediary4 : IntermediaryDetails RedemptionMultipleOrderV02 *-- "0..1" CopyInformation1 : CopyDetails RedemptionMultipleOrderV02 *-- "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 |
MultipleOrderDetails building block
General information related to the order. Instruction from an investor to sell investment fund units back to the fund. For comparison, see the ISO20022 official specification
classDiagram direction tb %% RedemptionMultipleOrder2 recursion level 0 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 %% CancellationRight1 recursion level 1 with max 1 class CancellationRight1{ Structured CancellationRight2Code AdditionalInformation IsoMax350Text } %% 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 %% IndividualPerson2 recursion level 1 with max 1 class IndividualPerson2{ Name IsoMax350Text BirthDate IsoISODate } IndividualPerson2 *-- "0..1" CountryAndResidentialStatusType1 : CountryAndResidentialStatus IndividualPerson2 *-- "0..0" GenericIdentification8 : OtherIdentification %% RedemptionOrder4 recursion level 1 with max 1 class RedemptionOrder4{ OrderReference IsoMax35Text NetAmount IsoActiveOrHistoricCurrencyAndAmount HoldingsRedemptionRate IsoPercentageRate Rounding RoundingDirection2Code GrossAmount IsoActiveOrHistoricCurrencyAndAmount IncomePreference IncomePreference1Code Group1Or2Units UKTaxGroupUnitCode PhysicalDeliveryIndicator IsoYesNoIndicator RequestedSettlementCurrency CurrencyCode RequestedNAVCurrency CurrencyCode } RedemptionOrder4 *-- "0..0" FundOrderType1 : OrderType RedemptionOrder4 *-- "1..1" FinancialInstrument6 : FinancialInstrumentDetails RedemptionOrder4 *-- "1..1" FinancialInstrumentQuantity1 : UnitsNumber RedemptionOrder4 *-- "0..1" ForeignExchangeTerms5 : ForeignExchangeDetails RedemptionOrder4 *-- "0..0" Charge8 : ChargeDetails RedemptionOrder4 *-- "0..0" Commission6 : CommissionDetails RedemptionOrder4 *-- "0..0" Tax6 : TaxDetails RedemptionOrder4 *-- "0..1" FundSettlementParameters3 : SettlementAndCustodyDetails RedemptionOrder4 *-- "0..1" DeliveryParameters3 : PhysicalDeliveryDetails RedemptionOrder4 *-- "0..1" PaymentTransaction15 : CashSettlementDetails %% PaymentTransaction15 recursion level 1 with max 1 class PaymentTransaction15{ SettlementAmount IsoActiveCurrencyAndAmount SettlementDate IsoISODate } PaymentTransaction15 *-- "0..1" IPaymentInstrument7Choice : PaymentInstrument
RedemptionMultipleOrder2 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
PlaceOfTrade | Market in which the advised trade transaction was executed. | CountryCode - Optional 0..1 |
OrderDateTime | Date and time at which the order was placed by the investor. | IsoISODateTime - Optional 0..1 |
ExpiryDateTime | Date on which the order expires. | IsoISODateTime - Optional 0..1 |
CancellationRight | Cancellation right of an investor with respect to an investment fund order. | CancellationRight1 - Optional 0..1 |
InvestmentAccountDetails | Account impacted by an investment fund order. | InvestmentAccount13 - Required 1..1 |
BeneficiaryDetails | Additional information about the investor. | IndividualPerson2 - Optional 0..1 |
IndividualOrderDetails | Instruction from an investor to sell investment fund units back to the fund. | RedemptionOrder4 - Unknown 1..0 |
BulkCashSettlementDetails | Payment transaction resulting from the investment fund order execution. | PaymentTransaction15 - Optional 0..1 |
IntermediaryDetails building block
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 RedemptionMultipleOrderV02 implementation follows a specific implementaiton pattern. First of all, RedemptionMultipleOrderV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, RedemptionMultipleOrderV02Document implements IOuterDocument. Because RedemptionMultipleOrderV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type RedemptionMultipleOrderV02.
classDiagram class IOuterRecord RedemptionMultipleOrderV02 --|> IOuterRecord : Implements RedemptionMultipleOrderV02Document --|> IOuterDocument~RedemptionMultipleOrderV02~ : Implements class IOuterDocument~RedemptionMultipleOrderV02~ { RedemptionMultipleOrderV02 Message }
Document wrapper for serialization
The only real purpose RedemptionMultipleOrderV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:setr.004.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using RedemptionMultipleOrderV02.ToDocument() method. The returned RedemptionMultipleOrderV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram RedemptionMultipleOrderV02Document *-- RedemptionMultipleOrderV02 : 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.004.001.02">
<setr.004.001.02>
<MstrRef>
<!-- MasterReference inner content -->
</MstrRef>
<PoolRef>
<!-- PoolReference inner content -->
</PoolRef>
<PrvsRef>
<!-- PreviousReference inner content -->
</PrvsRef>
<MltplOrdrDtls>
<!-- MultipleOrderDetails inner content -->
</MltplOrdrDtls>
<IntrmyDtls>
<!-- IntermediaryDetails inner content -->
</IntrmyDtls>
<CpyDtls>
<!-- CopyDetails inner content -->
</CpyDtls>
<Xtnsn>
<!-- Extension inner content -->
</Xtnsn>
</setr.004.001.02>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_rxRn99E7Ed-BzquC8wXy7w_-865600091"
nextVersions="_vhoUKNE7Ed-BzquC8wXy7w_2081067888"
name="RedemptionMultipleOrderV02"
definition="Scope
The RedemptionMultipleOrder 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 used to instruct the executing party to redeem to one or more financial instruments, for the same account.
Usage
The RedemptionMultipleOrder message is used for multiple orders. It may also be used for single orders, ie, a message containing one order for one financial instrument and related to one investment account. For a single redemption order, the RedemptionMultipleOrder message, not the RedemptionBulkOrder message, must be used.
If there are redemption orders for the same financial instrument but for different accounts, then the RedemptionBulkOrder must be used."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlName="setr.004.001.02"
xmlTag="setr.004.001.02"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_rxax5NE7Ed-BzquC8wXy7w_-725226293"
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 MultipleOrderDetails/InvestmentAccountDetails must be UNKNOWN."
registrationStatus="Provisionally Registered" />
<messageBuildingBlock
xmi:id="_rxRn-NE7Ed-BzquC8wXy7w_772037014"
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="_rxRn-dE7Ed-BzquC8wXy7w_769267720"
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="_rxRn-tE7Ed-BzquC8wXy7w_760033651"
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="_rxax4NE7Ed-BzquC8wXy7w_-351199912"
name="MultipleOrderDetails"
definition="General information related to the order."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MltplOrdrDtls"
complexType="_VddsSdp-Ed-ak6NoX_4Aeg_-438010863" />
<messageBuildingBlock
xmi:id="_rxax4dE7Ed-BzquC8wXy7w_527770974"
name="IntermediaryDetails"
definition="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="_rxax4tE7Ed-BzquC8wXy7w_-1422132281"
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="_rxax49E7Ed-BzquC8wXy7w_1076965137"
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="004"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.