setr.001.001.02
Scope The RedemptionBulkOrder 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 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, ie, account owners, but are 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 and bulking these individual orders into one bulk order before sending it to another party. For a single redemption order, the RedemptionMultipleOrder message, not the RedemptionBulkOrder message, must be used. If there are redemption orders for different financial instruments but for the same account, then the RedemptionMultipleOrder 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
%% RedemptionBulkOrderV02 recursion level 0 with max 0
RedemptionBulkOrderV02 *-- "0..1" AdditionalReference3 : MasterReference
RedemptionBulkOrderV02 *-- "0..1" AdditionalReference3 : PoolReference
RedemptionBulkOrderV02 *-- "0..1" AdditionalReference3 : PreviousReference
RedemptionBulkOrderV02 *-- "1..1" RedemptionBulkOrder2 : BulkOrderDetails
RedemptionBulkOrderV02 *-- "0..10" Intermediary4 : IntermediaryDetails
RedemptionBulkOrderV02 *-- "0..1" CopyInformation1 : CopyDetails
RedemptionBulkOrderV02 *-- "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 |
BulkOrderDetails building block
Common information related to all 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
%% RedemptionBulkOrder2 recursion level 0 with max 1
class RedemptionBulkOrder2{
PlaceOfTrade CountryCode
OrderDateTime IsoISODateTime
ExpiryDateTime IsoISODateTime
RequestedSettlementCurrency CurrencyCode
RequestedNAVCurrency CurrencyCode
}
RedemptionBulkOrder2 *-- "0..1" CancellationRight1 : CancellationRight
RedemptionBulkOrder2 *-- "1..1" FinancialInstrument6 : FinancialInstrumentDetails
RedemptionBulkOrder2 *-- "1..0" RedemptionOrder3 : IndividualOrderDetails
RedemptionBulkOrder2 *-- "0..1" PaymentTransaction18 : BulkCashSettlementDetails
%% CancellationRight1 recursion level 1 with max 1
class CancellationRight1{
Structured CancellationRight2Code
AdditionalInformation IsoMax350Text
}
%% FinancialInstrument6 recursion level 1 with max 1
class FinancialInstrument6{
Name IsoMax350Text
SupplementaryIdentification IsoMax35Text
ClassType IsoMax35Text
SecuritiesForm FormOfSecurity1Code
DistributionPolicy DistributionPolicy1Code
ProductGroup IsoMax140Text
}
FinancialInstrument6 *-- "1..1" ISecurityIdentification1Choice : Identification
%% RedemptionOrder3 recursion level 1 with max 1
class RedemptionOrder3{
OrderReference IsoMax35Text
NetAmount IsoActiveOrHistoricCurrencyAndAmount
HoldingsRedemptionRate IsoPercentageRate
Rounding RoundingDirection2Code
GrossAmount IsoActiveOrHistoricCurrencyAndAmount
IncomePreference IncomePreference1Code
Group1Or2Units UKTaxGroupUnitCode
PhysicalDeliveryIndicator IsoYesNoIndicator
}
RedemptionOrder3 *-- "0..0" FundOrderType1 : OrderType
RedemptionOrder3 *-- "1..1" InvestmentAccount13 : InvestmentAccountDetails
RedemptionOrder3 *-- "0..1" IndividualPerson2 : BeneficiaryDetails
RedemptionOrder3 *-- "1..1" FinancialInstrumentQuantity1 : UnitsNumber
RedemptionOrder3 *-- "0..1" ForeignExchangeTerms5 : ForeignExchangeDetails
RedemptionOrder3 *-- "0..0" Charge8 : ChargeDetails
RedemptionOrder3 *-- "0..0" Commission6 : CommissionDetails
RedemptionOrder3 *-- "0..0" Tax6 : TaxDetails
RedemptionOrder3 *-- "0..1" FundSettlementParameters3 : SettlementAndCustodyDetails
RedemptionOrder3 *-- "0..1" DeliveryParameters3 : PhysicalDeliveryDetails
RedemptionOrder3 *-- "0..1" PaymentTransaction18 : CashSettlementDetails
%% PaymentTransaction18 recursion level 1 with max 1
class PaymentTransaction18{
SettlementAmount IsoActiveCurrencyAndAmount
SettlementDate IsoISODate
}
PaymentTransaction18 *-- "1..1" IPaymentInstrument7Choice : PaymentInstrument
RedemptionBulkOrder2 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 |
| FinancialInstrumentDetails | Investment fund class related to an order. | FinancialInstrument6 - Required 1..1 |
| IndividualOrderDetails | Instruction from an investor to sell investment fund units back to the fund. | RedemptionOrder3 - Unknown 1..0 |
| RequestedSettlementCurrency | Currency requested for settlement of cash proceeds. | CurrencyCode - 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. | CurrencyCode - Optional 0..1 |
| BulkCashSettlementDetails | Payment transaction resulting from the investment fund order execution. | PaymentTransaction18 - 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 RedemptionBulkOrderV02 implementation follows a specific implementaiton pattern. First of all, RedemptionBulkOrderV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, RedemptionBulkOrderV02Document implements IOuterDocument. Because RedemptionBulkOrderV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type RedemptionBulkOrderV02.
classDiagram
class IOuterRecord
RedemptionBulkOrderV02 --|> IOuterRecord : Implements
RedemptionBulkOrderV02Document --|> IOuterDocument~RedemptionBulkOrderV02~ : Implements
class IOuterDocument~RedemptionBulkOrderV02~ {
RedemptionBulkOrderV02 Message
}
Document wrapper for serialization
The only real purpose RedemptionBulkOrderV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:setr.001.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using RedemptionBulkOrderV02.ToDocument() method. The returned RedemptionBulkOrderV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
RedemptionBulkOrderV02Document *-- RedemptionBulkOrderV02 : 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.02">
<setr.001.001.02>
<MstrRef>
<!-- MasterReference inner content -->
</MstrRef>
<PoolRef>
<!-- PoolReference inner content -->
</PoolRef>
<PrvsRef>
<!-- PreviousReference inner content -->
</PrvsRef>
<BlkOrdrDtls>
<!-- BulkOrderDetails inner content -->
</BlkOrdrDtls>
<IntrmyDtls>
<!-- IntermediaryDetails inner content -->
</IntrmyDtls>
<CpyDtls>
<!-- CopyDetails inner content -->
</CpyDtls>
<Xtnsn>
<!-- Extension inner content -->
</Xtnsn>
</setr.001.001.02>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_p-h38NE7Ed-BzquC8wXy7w_-1554802764"
nextVersions="_qYwV29E7Ed-BzquC8wXy7w_367657755"
name="RedemptionBulkOrderV02"
definition="Scope
The RedemptionBulkOrder 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 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, ie, account owners, but are 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 and bulking these individual orders into one bulk order before sending it to another party.
For a single redemption order, the RedemptionMultipleOrder message, not the RedemptionBulkOrder message, must be used.
If there are redemption orders for different financial instruments but for the same account, then the RedemptionMultipleOrder must be used."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlName="setr.001.001.02"
xmlTag="setr.001.001.02"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_p-ro8tE7Ed-BzquC8wXy7w_-1162304870"
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="_p-h38dE7Ed-BzquC8wXy7w_-1390267861"
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="_p-h38tE7Ed-BzquC8wXy7w_-1379184076"
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="_p-h389E7Ed-BzquC8wXy7w_-1381034585"
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="_p-h39NE7Ed-BzquC8wXy7w_-1057946997"
name="BulkOrderDetails"
definition="Common information related to all the orders."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="BlkOrdrDtls"
complexType="_Vc32aNp-Ed-ak6NoX_4Aeg_-1089349595" />
<messageBuildingBlock
xmi:id="_p-h39dE7Ed-BzquC8wXy7w_-1159389506"
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="_p-ro8NE7Ed-BzquC8wXy7w_-667614163"
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="_p-ro8dE7Ed-BzquC8wXy7w_-684127238"
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="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.