setr.009.001.02
Scope The SubscriptionBulkOrderConfirmation message is sent by an executing party, eg, a transfer agent, to an instructing party, eg, an investment manager or its authorised representative. There may be one or more intermediary parties between the executing party and the instructing 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 SubscriptionBulkOrder message. Usage The SubscriptionBulkOrderConfirmation message is sent, after the price has been determined, to confirm the execution of all individual orders. There is usually one bulk confirmation message for one bulk order message. A SubscriptionBulkOrder must in all cases be responded to by a SubscriptionBulkOrderConfirmation and in no circumstances by a SubscriptionMultipleOrderConfirmation. If the executing party needs to confirm a SubscriptionMultipleOrder message, then the SubscriptionMultipleOrderConfirmation 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 %% SubscriptionBulkOrderConfirmationV02 recursion level 0 with max 0 SubscriptionBulkOrderConfirmationV02 *-- "0..1" AdditionalReference3 : MasterReference SubscriptionBulkOrderConfirmationV02 *-- "0..1" AdditionalReference3 : PoolReference SubscriptionBulkOrderConfirmationV02 *-- "0..1" AdditionalReference3 : PreviousReference SubscriptionBulkOrderConfirmationV02 *-- "1..1" AdditionalReference3 : RelatedReference SubscriptionBulkOrderConfirmationV02 *-- "1..1" SubscriptionBulkExecution2 : BulkExecutionDetails SubscriptionBulkOrderConfirmationV02 *-- "0..10" Intermediary4 : IntermediaryDetails SubscriptionBulkOrderConfirmationV02 *-- "0..1" CopyInformation1 : CopyDetails SubscriptionBulkOrderConfirmationV02 *-- "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 |
BulkExecutionDetails building block
General information related to the execution of investment orders. Execution of a subscription order. For comparison, see the ISO20022 official specification
classDiagram direction tb %% SubscriptionBulkExecution2 recursion level 0 with max 1 class SubscriptionBulkExecution2{ PlaceOfTrade CountryCode OrderDateTime IsoISODateTime RequestedSettlementCurrency CurrencyCode RequestedNAVCurrency CurrencyCode } SubscriptionBulkExecution2 *-- "0..1" CancellationRight1 : CancellationRight SubscriptionBulkExecution2 *-- "1..1" FinancialInstrument6 : FinancialInstrumentDetails SubscriptionBulkExecution2 *-- "1..0" SubscriptionExecution3 : IndividualExecutionDetails SubscriptionBulkExecution2 *-- "0..1" PaymentTransaction16 : 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 %% SubscriptionExecution3 recursion level 1 with max 1 class SubscriptionExecution3{ OrderReference IsoMax35Text DealReference IsoMax35Text Rounding RoundingDirection2Code NetAmount IsoActiveCurrencyAndAmount GrossAmount IsoActiveCurrencyAndAmount PartiallyExecutedIndicator IsoYesNoIndicator CumDividendIndicator IsoYesNoIndicator IncomePreference IncomePreference1Code LetterIntentReference IsoMax35Text AccumulationRightReference IsoMax35Text PhysicalDeliveryIndicator IsoYesNoIndicator Refund IsoActiveCurrencyAndAmount SubscriptionInterest IsoActiveCurrencyAndAmount } SubscriptionExecution3 *-- "0..0" FundOrderType1 : OrderType SubscriptionExecution3 *-- "1..1" InvestmentAccount13 : InvestmentAccountDetails SubscriptionExecution3 *-- "0..1" IndividualPerson2 : BeneficiaryDetails SubscriptionExecution3 *-- "1..1" FinancialInstrumentQuantity1 : UnitsNumber SubscriptionExecution3 *-- "1..1" IDateAndDateTimeChoice : TradeDateTime SubscriptionExecution3 *-- "1..1" UnitPrice5 : PriceDetails SubscriptionExecution3 *-- "0..1" IProfitAndLoss1Choice : InterimProfitAmount SubscriptionExecution3 *-- "0..0" ForeignExchangeTerms4 : ForeignExchangeDetails SubscriptionExecution3 *-- "0..1" TotalCharges2 : ChargeGeneralDetails SubscriptionExecution3 *-- "0..1" TotalCommissions2 : CommissionGeneralDetails SubscriptionExecution3 *-- "0..1" TotalTaxes2 : TaxGeneralDetails SubscriptionExecution3 *-- "0..1" FundSettlementParameters3 : SettlementAndCustodyDetails SubscriptionExecution3 *-- "0..1" DeliveryParameters3 : PhysicalDeliveryDetails SubscriptionExecution3 *-- "0..1" PaymentTransaction16 : CashSettlementDetails %% PaymentTransaction16 recursion level 1 with max 1 class PaymentTransaction16{ SettlementAmount IsoActiveCurrencyAndAmount SettlementDate IsoISODate } PaymentTransaction16 *-- "0..1" IPaymentInstrument8Choice : PaymentInstrument
SubscriptionBulkExecution2 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 |
CancellationRight | Cancellation right of an investor with respect to an investment fund order. | CancellationRight1 - Optional 0..1 |
FinancialInstrumentDetails | Investment fund class to which an investment fund order execution is related. | FinancialInstrument6 - Required 1..1 |
IndividualExecutionDetails | Execution of a subscription order. | SubscriptionExecution3 - 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. | PaymentTransaction16 - Optional 0..1 |
IntermediaryDetails building block
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 SubscriptionBulkOrderConfirmationV02 implementation follows a specific implementaiton pattern. First of all, SubscriptionBulkOrderConfirmationV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SubscriptionBulkOrderConfirmationV02Document implements IOuterDocument. Because SubscriptionBulkOrderConfirmationV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SubscriptionBulkOrderConfirmationV02.
classDiagram class IOuterRecord SubscriptionBulkOrderConfirmationV02 --|> IOuterRecord : Implements SubscriptionBulkOrderConfirmationV02Document --|> IOuterDocument~SubscriptionBulkOrderConfirmationV02~ : Implements class IOuterDocument~SubscriptionBulkOrderConfirmationV02~ { SubscriptionBulkOrderConfirmationV02 Message }
Document wrapper for serialization
The only real purpose SubscriptionBulkOrderConfirmationV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:setr.009.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SubscriptionBulkOrderConfirmationV02.ToDocument() method. The returned SubscriptionBulkOrderConfirmationV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram SubscriptionBulkOrderConfirmationV02Document *-- SubscriptionBulkOrderConfirmationV02 : 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.009.001.02">
<setr.009.001.02>
<MstrRef>
<!-- MasterReference inner content -->
</MstrRef>
<PoolRef>
<!-- PoolReference inner content -->
</PoolRef>
<PrvsRef>
<!-- PreviousReference inner content -->
</PrvsRef>
<RltdRef>
<!-- RelatedReference inner content -->
</RltdRef>
<BlkExctnDtls>
<!-- BulkExecutionDetails inner content -->
</BlkExctnDtls>
<IntrmyDtls>
<!-- IntermediaryDetails inner content -->
</IntrmyDtls>
<CpyDtls>
<!-- CopyDetails inner content -->
</CpyDtls>
<Xtnsn>
<!-- Extension inner content -->
</Xtnsn>
</setr.009.001.02>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_y7Cf-NE7Ed-BzquC8wXy7w_-384105664"
nextVersions="_zVj4wNE7Ed-BzquC8wXy7w_616882747"
name="SubscriptionBulkOrderConfirmationV02"
definition="Scope
The SubscriptionBulkOrderConfirmation message is sent by an executing party, eg, a transfer agent, to an instructing party, eg, an investment manager or its authorised representative. There may be one or more intermediary parties between the executing party and the instructing 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 SubscriptionBulkOrder message.
Usage
The SubscriptionBulkOrderConfirmation message is sent, after the price has been determined, to confirm the execution of all individual orders.
There is usually one bulk confirmation message for one bulk order message.
A SubscriptionBulkOrder must in all cases be responded to by a SubscriptionBulkOrderConfirmation and in no circumstances by a SubscriptionMultipleOrderConfirmation.
If the executing party needs to confirm a SubscriptionMultipleOrder message, then the SubscriptionMultipleOrderConfirmation message must be used."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlName="setr.009.001.02"
xmlTag="setr.009.001.02"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_y7Lp5dE7Ed-BzquC8wXy7w_-313918114"
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 BulkExecutionDetails/IndividualExecutionDetails/InvestmentAccountDetails must be UNKNOWN."
registrationStatus="Provisionally Registered" />
<messageBuildingBlock
xmi:id="_y7Cf-dE7Ed-BzquC8wXy7w_786016250"
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="_y7Cf-tE7Ed-BzquC8wXy7w_772163807"
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="_y7Cf-9E7Ed-BzquC8wXy7w_783244126"
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="_y7Lp4NE7Ed-BzquC8wXy7w_788786679"
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="_y7Lp4dE7Ed-BzquC8wXy7w_-168002725"
name="BulkExecutionDetails"
definition="General information related to the execution of investment orders."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="BlkExctnDtls"
complexType="_VUO3wtp-Ed-ak6NoX_4Aeg_-215103151" />
<messageBuildingBlock
xmi:id="_y7Lp4tE7Ed-BzquC8wXy7w_-355126411"
name="IntermediaryDetails"
definition="Information related to an intermediary."
registrationStatus="Provisionally Registered"
maxOccurs="10"
minOccurs="0"
xmlTag="IntrmyDtls"
complexType="_U_XbBdp-Ed-ak6NoX_4Aeg_-129041693" />
<messageBuildingBlock
xmi:id="_y7Lp49E7Ed-BzquC8wXy7w_-1785604561"
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="_y7Lp5NE7Ed-BzquC8wXy7w_1147481101"
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="009"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.