setr.001.001.04
Scope The RedemptionBulkOrder 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 a redemption from a financial instrument for two or more accounts. Usage The RedemptionBulkOrder message is used to bulk several individual orders into one bulk order. The individual orders come from different instructing parties, that is, account owners, but are for the same financial instrument. The RedemptionBulkOrder can result in one single bulk cash settlement or several individual cash settlements. This message will be typically used by a party collecting orders, that is, a concentrator, bulking these individual orders into one bulk order before sending it to an executing party. For a single redemption order, the RedemptionOrder message, not the RedemptionBulkOrder message, must be used. If there are redemption orders for different financial instruments but for the same account, then the RedemptionOrder 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
%% RedemptionBulkOrderV04 recursion level 0 with max 0
RedemptionBulkOrderV04 *-- "1..1" MessageIdentification1 : MessageIdentification
RedemptionBulkOrderV04 *-- "0..1" AdditionalReference9 : PoolReference
RedemptionBulkOrderV04 *-- "0..1" AdditionalReference8 : PreviousReference
RedemptionBulkOrderV04 *-- "1..1" RedemptionBulkOrder6 : BulkOrderDetails
RedemptionBulkOrderV04 *-- "0..1" CopyInformation4 : CopyDetails
RedemptionBulkOrderV04 *-- "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
| 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
%% 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
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Reference | Reference identifying a set of messages. | IsoMax35Text - Required 1..1 |
| ReferenceIssuer | Issuer of the reference. | PartyIdentification113 - Optional 0..1 |
| MessageName | Name of the 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
%% 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
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Reference | Reference issued by a party to identify an instruction, transaction or a message. | IsoMax35Text - Required 1..1 |
| ReferenceIssuer | Issuer of the reference. | PartyIdentification113 - Optional 0..1 |
| MessageName | Name of the message. | IsoMax35Text - Optional 0..1 |
BulkOrderDetails 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
%% RedemptionBulkOrder6 recursion level 0 with max 1
class RedemptionBulkOrder6{
MasterReference IsoMax35Text
OrderDateTime IsoISODateTime
RequestedFutureTradeDate IsoISODate
RequestedSettlementCurrency ActiveCurrencyCode
RequestedNAVCurrency ActiveOrHistoricCurrencyCode
TotalSettlementAmount IsoActiveCurrencyAndAmount
}
RedemptionBulkOrder6 *-- "0..1" IPlaceOfTradeIdentification1Choice : PlaceOfTrade
RedemptionBulkOrder6 *-- "0..1" IDateAndDateTimeChoice : ExpiryDateTime
RedemptionBulkOrder6 *-- "0..1" ICancellationRight1Choice : CancellationRight
RedemptionBulkOrder6 *-- "1..1" FinancialInstrument57 : FinancialInstrumentDetails
RedemptionBulkOrder6 *-- "1..0" RedemptionOrder15 : IndividualOrderDetails
RedemptionBulkOrder6 *-- "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
%% FinancialInstrument57 recursion level 1 with max 1
class FinancialInstrument57{
Name IsoMax350Text
ShortName IsoMax35Text
SupplementaryIdentification IsoMax35Text
ClassType IsoMax35Text
SecuritiesForm FormOfSecurity1Code
DistributionPolicy DistributionPolicy1Code
ProductGroup IsoMax140Text
}
FinancialInstrument57 *-- "1..1" ISecurityIdentification25Choice : Identification
FinancialInstrument57 *-- "0..1" Series1 : SeriesIdentification
%% RedemptionOrder15 recursion level 1 with max 1
class RedemptionOrder15{
OrderReference IsoMax35Text
ClientReference IsoMax35Text
Rounding RoundingDirection2Code
SettlementAmount IsoActiveCurrencyAndAmount
CashSettlementDate IsoISODate
SettlementMethod DeliveryReceiptType2Code
IncomePreference IncomePreference1Code
Group1Or2Units UKTaxGroupUnit1Code
PhysicalDeliveryIndicator IsoYesNoIndicator
NonStandardSettlementInformation IsoMax350Text
FinancialAdvice FinancialAdvice1Code
NegotiatedTrade NegotiatedTrade1Code
}
RedemptionOrder15 *-- "1..1" InvestmentAccount58 : InvestmentAccountDetails
RedemptionOrder15 *-- "0..10" IFundOrderType4Choice : OrderType
RedemptionOrder15 *-- "0..0" IndividualPerson32 : BeneficiaryDetails
RedemptionOrder15 *-- "1..1" IFinancialInstrumentQuantity28Choice : AmountOrUnitsOrPercentage
RedemptionOrder15 *-- "0..1" ForeignExchangeTerms32 : ForeignExchangeDetails
RedemptionOrder15 *-- "0..1" FeeAndTax1 : TransactionOverhead
RedemptionOrder15 *-- "0..1" FundSettlementParameters12 : SettlementAndCustodyDetails
RedemptionOrder15 *-- "0..1" DeliveryParameters3 : PhysicalDeliveryDetails
RedemptionOrder15 *-- "0..1" PaymentTransaction72 : CashSettlementDetails
RedemptionOrder15 *-- "0..4" InvestmentFundsOrderBreakdown2 : StaffClientBreakdown
RedemptionOrder15 *-- "0..10" Intermediary40 : RelatedPartyDetails
RedemptionOrder15 *-- "0..1" Equalisation1 : Equalisation
RedemptionOrder15 *-- "0..1" ICustomerConductClassification1Choice : CustomerConductClassification
RedemptionOrder15 *-- "0..1" ITransactionChannelType1Choice : TransactionChannelType
RedemptionOrder15 *-- "0..1" ISignatureType1Choice : SignatureType
RedemptionOrder15 *-- "0..1" OrderWaiver1 : OrderWaiverDetails
%% PaymentTransaction72 recursion level 1 with max 1
PaymentTransaction72 *-- "1..1" IPaymentInstrument21Choice : PaymentInstrument
RedemptionBulkOrder6 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MasterReference | Unique and unambiguous identifier for a group of individual orders, as assigned by the instructing party. This identifier links the individual orders together. | IsoMax35Text - Optional 0..1 |
| PlaceOfTrade | Market in which the advised trade transaction was executed. | IPlaceOfTradeIdentification1Choice - Optional 0..1 |
| OrderDateTime | Date and time the order is placed by the investor or its agent. | IsoISODateTime - Optional 0..1 |
| ExpiryDateTime | Date on which the order expires. | IDateAndDateTimeChoice - Optional 0..1 |
| RequestedFutureTradeDate | Future date at which the investor requests the order to be executed. | The specification of a requested future trade date is not allowed in some markets. The date must be a date in the future. |
| CancellationRight | Cancellation right of the investor with respect to the investment fund order. | ICancellationRight1Choice - Optional 0..1 |
| FinancialInstrumentDetails | Investment fund class related to the order. | FinancialInstrument57 - Required 1..1 |
| IndividualOrderDetails | Instruction from an investor to sell investment fund units back to the fund. | RedemptionOrder15 - Unknown 1..0 |
| RequestedSettlementCurrency | Currency requested for settlement of cash proceeds. | ActiveCurrencyCode - Optional 0..1 |
| RequestedNAVCurrency | Currency to be used for pricing the fund. This currency must be among the set of currencies in which the price may be expressed, as stated in the prospectus. | ActiveOrHistoricCurrencyCode - Optional 0..1 |
| TotalSettlementAmount | Total amount of money paid /to be paid or received in exchange for the financial instrument in the multiple order. | IsoActiveCurrencyAndAmount - Optional 0..1 |
| BulkCashSettlementDetails | Payment process for the transfer of cash from the debtor to the creditor. | PaymentTransaction72 - 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
%% CopyInformation4 recursion level 0 with max 1
class CopyInformation4{
CopyIndicator IsoYesNoIndicator
OriginalReceiver IsoAnyBICIdentifier
}
CopyInformation4 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. | IsoAnyBICIdentifier - Optional 0..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 RedemptionBulkOrderV04 implementation follows a specific implementaiton pattern. First of all, RedemptionBulkOrderV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, RedemptionBulkOrderV04Document implements IOuterDocument. Because RedemptionBulkOrderV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type RedemptionBulkOrderV04.
classDiagram
class IOuterRecord
RedemptionBulkOrderV04 --|> IOuterRecord : Implements
RedemptionBulkOrderV04Document --|> IOuterDocument~RedemptionBulkOrderV04~ : Implements
class IOuterDocument~RedemptionBulkOrderV04~ {
RedemptionBulkOrderV04 Message
}
Document wrapper for serialization
The only real purpose RedemptionBulkOrderV04Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:setr.001.001.04’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using RedemptionBulkOrderV04.ToDocument() method. The returned RedemptionBulkOrderV04Document value will serialize correctly according to ISO 20022 standards.
classDiagram
RedemptionBulkOrderV04Document *-- RedemptionBulkOrderV04 : 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.001.001.04">
<RedBlkOrdr>
<MsgId>
<!-- MessageIdentification inner content -->
</MsgId>
<PoolRef>
<!-- PoolReference inner content -->
</PoolRef>
<PrvsRef>
<!-- PreviousReference inner content -->
</PrvsRef>
<BlkOrdrDtls>
<!-- BulkOrderDetails inner content -->
</BlkOrdrDtls>
<CpyDtls>
<!-- CopyDetails inner content -->
</CpyDtls>
<Xtnsn>
<!-- Extension inner content -->
</Xtnsn>
</RedBlkOrdr>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_AaSJATbLEead9bDRE_1DAQ"
previousVersion="_qYwV29E7Ed-BzquC8wXy7w_367657755"
name="RedemptionBulkOrderV04"
definition="Scope
The RedemptionBulkOrder 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 a redemption from a financial instrument for two or more accounts.
Usage
The RedemptionBulkOrder message is used to bulk several individual orders into one bulk order. The individual orders come from different instructing parties, that is, account owners, but are for the same financial instrument. The RedemptionBulkOrder can result in one single bulk cash settlement or several individual cash settlements.
This message will be typically used by a party collecting orders, that is, a concentrator, bulking these individual orders into one bulk order before sending it to an executing party.
For a single redemption order, the RedemptionOrder message, not the RedemptionBulkOrder message, must be used.
If there are redemption orders for different financial instruments but for the same account, then the RedemptionOrder must be used."
registrationStatus="Registered"
messageSet="_hijK0WiLEeOuqdLlpUIWBw _qCumkAFwEeu2__1EbNXzuA"
xmlTag="RedBlkOrdr"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_AaSJAzbLEead9bDRE_1DAQ"
previousVersion="_qY6G1dE7Ed-BzquC8wXy7w_498798392"
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 BulkOrderDetails/IndividualOrderDetails/InvestmentAccountDetails must be UNKNOWN."
registrationStatus="Provisionally Registered" />
<messageBuildingBlock
xmi:id="_AaSJCTbLEead9bDRE_1DAQ"
previousVersion="_qYwV3NE7Ed-BzquC8wXy7w_-2023497525"
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="_AaSJCzbLEead9bDRE_1DAQ"
previousVersion="_qYwV3dE7Ed-BzquC8wXy7w_568061385"
name="PoolReference"
definition="Collective reference identifying a set of messages."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PoolRef"
complexType="_N4g3EXETEea2e4bzJ8TyEw" />
<messageBuildingBlock
xmi:id="_AaSJDTbLEead9bDRE_1DAQ"
previousVersion="_qY6G0NE7Ed-BzquC8wXy7w_565291860"
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="_AaSJDzbLEead9bDRE_1DAQ"
previousVersion="_qY6G0dE7Ed-BzquC8wXy7w_1784338680"
name="BulkOrderDetails"
definition="General information related to the orders."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="BlkOrdrDtls"
complexType="_5uS5vTbsEead9bDRE_1DAQ" />
<messageBuildingBlock
xmi:id="_AaSJEzbLEead9bDRE_1DAQ"
previousVersion="_qY6G09E7Ed-BzquC8wXy7w_1223759992"
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="_AaSJFTbLEead9bDRE_1DAQ"
previousVersion="_qY6G1NE7Ed-BzquC8wXy7w_1225608863"
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="001"
flavour="001"
version="04" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.