RedemptionOrderV04

setr.004.001.04

Scope The RedemptionOrder message is sent by an instructing party, for example, an investment manager or its authorised representative, to the executing party, for example, a transfer agent, to instruct the redemption of one or more financial instruments for one investment fund account. Usage The RedemptionOrder message is used to instruct single redemption orders, that is, a message containing one order for one financial instrument and related to one investment account. The RedemptionOrder message may also be used for multiple orders, that is, a message containing several orders related to the same investment account for different financial instruments. For a single redemption order, the RedemptionOrder message, not the RedemptionBulkOrder message, must be used. If there are redemption orders for the same financial instrument but for different accounts that are to be communicated in a single message, then the RedemptionBulkOrder message 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
%% RedemptionOrderV04 recursion level 0 with max 0
RedemptionOrderV04 *-- "1..1" MessageIdentification1 : MessageIdentification
RedemptionOrderV04 *-- "0..1" AdditionalReference9 : PoolReference
RedemptionOrderV04 *-- "0..1" AdditionalReference8 : PreviousReference
RedemptionOrderV04 *-- "1..1" RedemptionMultipleOrder6 : MultipleOrderDetails
RedemptionOrderV04 *-- "0..1" CopyInformation4 : CopyDetails
RedemptionOrderV04 *-- "0..1" Extension1 : Extension
  

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

MessageIdentification building block

Reference that uniquely identifies the 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
%% AdditionalReference9 recursion level 0 with max 1
class AdditionalReference9{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference9 *-- "0..1" PartyIdentification113 : ReferenceIssuer
%% PartyIdentification113 recursion level 1 with max 1
class PartyIdentification113{
    LEI IsoLEIIdentifier
}
PartyIdentification113 *-- "1..1" IPartyIdentification90Choice : Party
  

AdditionalReference9 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
%% AdditionalReference8 recursion level 0 with max 1
class AdditionalReference8{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference8 *-- "0..1" PartyIdentification113 : ReferenceIssuer
%% PartyIdentification113 recursion level 1 with max 1
class PartyIdentification113{
    LEI IsoLEIIdentifier
}
PartyIdentification113 *-- "1..1" IPartyIdentification90Choice : Party
  

AdditionalReference8 members

MultipleOrderDetails building block

General information related to the orders. Instruction from an investor to sell investment fund units back to the fund. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% RedemptionMultipleOrder6 recursion level 0 with max 1
class RedemptionMultipleOrder6{
    MasterReference IsoMax35Text
    OrderDateTime IsoISODateTime
    RequestedFutureTradeDate IsoISODate
    TotalSettlementAmount IsoActiveCurrencyAndAmount
}
RedemptionMultipleOrder6 *-- "0..1" IPlaceOfTradeIdentification1Choice : PlaceOfTrade
RedemptionMultipleOrder6 *-- "0..1" IDateAndDateTimeChoice : ExpiryDateTime
RedemptionMultipleOrder6 *-- "0..1" ICancellationRight1Choice : CancellationRight
RedemptionMultipleOrder6 *-- "1..1" InvestmentAccount58 : InvestmentAccountDetails
RedemptionMultipleOrder6 *-- "0..0" IndividualPerson32 : BeneficiaryDetails
RedemptionMultipleOrder6 *-- "1..0" RedemptionOrder14 : IndividualOrderDetails
RedemptionMultipleOrder6 *-- "0..1" PaymentTransaction72 : BulkCashSettlementDetails
%% IPlaceOfTradeIdentification1Choice recursion level 1 with max 1
%% IDateAndDateTimeChoice recursion level 1 with max 1
%% ICancellationRight1Choice recursion level 1 with max 1
%% InvestmentAccount58 recursion level 1 with max 1
class InvestmentAccount58{
    AccountIdentification IsoMax35Text
    AccountName IsoMax35Text
    AccountDesignation IsoMax35Text
    OrderOriginatorEligibility OrderOriginatorEligibility1Code
}
InvestmentAccount58 *-- "0..0" PartyIdentification113 : OwnerIdentification
InvestmentAccount58 *-- "0..1" PartyIdentification113 : AccountServicer
InvestmentAccount58 *-- "0..1" SubAccount6 : SubAccountDetails
%% IndividualPerson32 recursion level 1 with max 1
class IndividualPerson32{
    Name IsoMax350Text
    BirthDate IsoISODate
}
IndividualPerson32 *-- "0..1" CountryAndResidentialStatusType2 : CountryAndResidentialStatus
IndividualPerson32 *-- "0..0" GenericIdentification164 : OtherIdentification
%% RedemptionOrder14 recursion level 1 with max 1
class RedemptionOrder14{
    OrderReference IsoMax35Text
    ClientReference IsoMax35Text
    Rounding RoundingDirection2Code
    SettlementAmount IsoActiveCurrencyAndAmount
    CashSettlementDate IsoISODate
    SettlementMethod DeliveryReceiptType2Code
    IncomePreference IncomePreference1Code
    Group1Or2Units UKTaxGroupUnit1Code
    PhysicalDeliveryIndicator IsoYesNoIndicator
    RequestedSettlementCurrency ActiveCurrencyCode
    RequestedNAVCurrency ActiveOrHistoricCurrencyCode
    NonStandardSettlementInformation IsoMax350Text
    FinancialAdvice FinancialAdvice1Code
    NegotiatedTrade NegotiatedTrade1Code
}
RedemptionOrder14 *-- "0..10" IFundOrderType4Choice : OrderType
RedemptionOrder14 *-- "1..1" FinancialInstrument57 : FinancialInstrumentDetails
RedemptionOrder14 *-- "0..1" SubAccount6 : SubAccountForHolding
RedemptionOrder14 *-- "1..1" IFinancialInstrumentQuantity28Choice : AmountOrUnitsOrPercentage
RedemptionOrder14 *-- "0..1" ForeignExchangeTerms32 : ForeignExchangeDetails
RedemptionOrder14 *-- "0..1" FeeAndTax1 : TransactionOverhead
RedemptionOrder14 *-- "0..1" FundSettlementParameters12 : SettlementAndCustodyDetails
RedemptionOrder14 *-- "0..1" DeliveryParameters3 : PhysicalDeliveryDetails
RedemptionOrder14 *-- "0..1" PaymentTransaction72 : CashSettlementDetails
RedemptionOrder14 *-- "0..4" InvestmentFundsOrderBreakdown2 : StaffClientBreakdown
RedemptionOrder14 *-- "0..10" Intermediary40 : RelatedPartyDetails
RedemptionOrder14 *-- "0..1" Equalisation1 : Equalisation
RedemptionOrder14 *-- "0..1" ICustomerConductClassification1Choice : CustomerConductClassification
RedemptionOrder14 *-- "0..1" ITransactionChannelType1Choice : TransactionChannelType
RedemptionOrder14 *-- "0..1" ISignatureType1Choice : SignatureType
RedemptionOrder14 *-- "0..1" OrderWaiver1 : OrderWaiverDetails
%% PaymentTransaction72 recursion level 1 with max 1
PaymentTransaction72 *-- "1..1" IPaymentInstrument21Choice : PaymentInstrument
  

RedemptionMultipleOrder6 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
%% CopyInformation4 recursion level 0 with max 1
class CopyInformation4{
    CopyIndicator IsoYesNoIndicator
    OriginalReceiver IsoAnyBICIdentifier
}
  

CopyInformation4 members

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

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    RedemptionOrderV04 --|> IOuterRecord : Implements
    RedemptionOrderV04Document --|> IOuterDocument~RedemptionOrderV04~ : Implements
    class IOuterDocument~RedemptionOrderV04~ {
        RedemptionOrderV04 Message
     }
  

Document wrapper for serialization

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

classDiagram
    RedemptionOrderV04Document *-- RedemptionOrderV04 : 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.04">
    <RedOrdr>
        <MsgId>
            <!-- MessageIdentification inner content -->
        </MsgId>
        <PoolRef>
            <!-- PoolReference inner content -->
        </PoolRef>
        <PrvsRef>
            <!-- PreviousReference inner content -->
        </PrvsRef>
        <MltplOrdrDtls>
            <!-- MultipleOrderDetails inner content -->
        </MltplOrdrDtls>
        <CpyDtls>
            <!-- CopyDetails inner content -->
        </CpyDtls>
        <Xtnsn>
            <!-- Extension inner content -->
        </Xtnsn>
    </RedOrdr>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_Aab6GzbLEead9bDRE_1DAQ"
  previousVersion="_vhoUKNE7Ed-BzquC8wXy7w_2081067888"
  name="RedemptionOrderV04"
  definition="Scope&#xD;&#xA;The RedemptionOrder message is sent by an instructing party, for example, an investment manager or its authorised representative, to the executing party, for example, a transfer agent, to instruct the redemption of one or more financial instruments for one investment fund account.&#xD;&#xA;Usage&#xD;&#xA;The RedemptionOrder message is used to instruct single redemption orders, that is, a message containing one order for one financial instrument and related to one investment account. The RedemptionOrder message may also be used for multiple orders, that is, a message containing several orders related to the same investment account for different financial instruments.&#xD;&#xA;For a single redemption order, the RedemptionOrder message, not the RedemptionBulkOrder message, must be used.&#xD;&#xA;If there are redemption orders for the same financial instrument but for different accounts that are to be communicated in a single message, then the RedemptionBulkOrder message must be used."
  registrationStatus="Registered"
  messageSet="_hijK0WiLEeOuqdLlpUIWBw _qCumkAFwEeu2__1EbNXzuA"
  xmlTag="RedOrdr"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_Aab6HTbLEead9bDRE_1DAQ"
    previousVersion="_vhxeFdE7Ed-BzquC8wXy7w_-2126165300"
    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="_Aab6IzbLEead9bDRE_1DAQ"
    previousVersion="_vhoUKdE7Ed-BzquC8wXy7w_-1426904851"
    name="MessageIdentification"
    definition="Reference that uniquely identifies the message from a business application standpoint."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_Aab6JTbLEead9bDRE_1DAQ"
    previousVersion="_vhoUKtE7Ed-BzquC8wXy7w_-1796466923"
    name="PoolReference"
    definition="Collective reference identifying a set of messages."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PoolRef"
    complexType="_N4g3EXETEea2e4bzJ8TyEw" />
  <messageBuildingBlock
    xmi:id="_Aab6JzbLEead9bDRE_1DAQ"
    previousVersion="_vhxeENE7Ed-BzquC8wXy7w_-1793698233"
    name="PreviousReference"
    definition="Reference to a linked message that was previously sent."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="PrvsRef"
    complexType="_udnPoTbsEead9bDRE_1DAQ" />
  <messageBuildingBlock
    xmi:id="_Aab6KTbLEead9bDRE_1DAQ"
    previousVersion="_vhxeEdE7Ed-BzquC8wXy7w_576058002"
    name="MultipleOrderDetails"
    definition="General information related to the orders."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MltplOrdrDtls"
    complexType="_7RE7JTbsEead9bDRE_1DAQ" />
  <messageBuildingBlock
    xmi:id="_Aab6LTbLEead9bDRE_1DAQ"
    previousVersion="_vhxeE9E7Ed-BzquC8wXy7w_-1565586255"
    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="_7VUJ8degEeSA_uUacqhl1Q" />
  <messageBuildingBlock
    xmi:id="_Aab6LzbLEead9bDRE_1DAQ"
    previousVersion="_vhxeFNE7Ed-BzquC8wXy7w_-1557274391"
    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="04" />
</messageDefinition>

ISO Building Blocks

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