Iso20022

OrderConfirmationStatusReportV01

setr.057.001.01

Scope An instructing party, for example, an investment manager or its authorised representative, sends the OrderConfirmationStatusReport message to the executing party, for example, a transfer agent, to report the status of an order confirmation or an order confirmation amendment. Usage The OrderConfirmationStatusReport message is used to report on the status of one or more individual:

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
%% OrderConfirmationStatusReportV01 recursion level 0 with max 0
OrderConfirmationStatusReportV01 *-- "1..1" MessageIdentification1 : MessageIdentification
OrderConfirmationStatusReportV01 *-- "0..2" AdditionalReference3 : OtherReference
OrderConfirmationStatusReportV01 *-- "0..2" AdditionalReference3 : RelatedReference
OrderConfirmationStatusReportV01 *-- "1..1" IndividualOrderConfirmationStatusAndReason1 : IndividualOrderConfirmationDetailsReport
OrderConfirmationStatusReportV01 *-- "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 a 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

OtherReference building block

Reference to a linked message sent in a proprietary way or reference of a system. 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

IndividualOrderConfirmationDetailsReport building block

Status report details of an individual order confirmation. Status report of the individual orders confirmation that was previously received. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IndividualOrderConfirmationStatusAndReason1 recursion level 0 with max 1
class IndividualOrderConfirmationStatusAndReason1{
    MasterReference IsoMax35Text
    OrderReference IsoMax35Text
    ClientReference IsoMax35Text
    DealReference IsoMax35Text
    Status OrderConfirmationStatus1Code
}
IndividualOrderConfirmationStatusAndReason1 *-- "1..10" ConfirmationRejectedStatus1 : ConfirmationRejected
IndividualOrderConfirmationStatusAndReason1 *-- "1..10" ConfirmationRejectedStatus1 : AmendmentRejected
IndividualOrderConfirmationStatusAndReason1 *-- "0..1" IPartyIdentification2Choice : StatusInitiator
IndividualOrderConfirmationStatusAndReason1 *-- "0..1" InvestmentAccount13 : InvestmentAccountDetails
IndividualOrderConfirmationStatusAndReason1 *-- "0..1" FinancialInstrument10 : FinancialInstrumentDetails
%% ConfirmationRejectedStatus1 recursion level 1 with max 1
class ConfirmationRejectedStatus1{
    Reason RejectedConfirmationStatusReason1Code
    ExtendedReason IsoExtended350Code
}
ConfirmationRejectedStatus1 *-- "1..1" GenericIdentification1 : DataSourceScheme
%% ConfirmationRejectedStatus1 recursion level 1 with max 1
class ConfirmationRejectedStatus1{
    Reason RejectedConfirmationStatusReason1Code
    ExtendedReason IsoExtended350Code
}
ConfirmationRejectedStatus1 *-- "1..1" GenericIdentification1 : DataSourceScheme
%% IPartyIdentification2Choice recursion level 1 with max 1
%% 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
%% FinancialInstrument10 recursion level 1 with max 1
class FinancialInstrument10{
    Name IsoMax350Text
    SupplementaryIdentification IsoMax35Text
    ClassType IsoMax35Text
    SecuritiesForm FormOfSecurity1Code
    DistributionPolicy DistributionPolicy1Code
    ProductGroup IsoMax140Text
}
FinancialInstrument10 *-- "1..1" ISecurityIdentification3Choice : Identification

IndividualOrderConfirmationStatusAndReason1 members

Member name Description Data Type / Multiplicity
MasterReference Reference assigned to a set of orders or trades in order to link them together. IsoMax35Text - Optional 0..1
OrderReference Unique and unambiguous identifier for an order, as assigned by the instructing party. IsoMax35Text - Required 1..1
ClientReference Unique and unambiguous investor’s identification of an order. This reference can typically be used in a hub scenario to give the reference of the order as assigned by the underlying client. IsoMax35Text - Optional 0..1
DealReference Unique and unambiguous identifier for an order execution, as assigned by a confirming party. IsoMax35Text - Optional 0..1
ConfirmationRejected Status of the order confirmation is rejected. ConfirmationRejectedStatus1 - Collection 1..10
AmendmentRejected Status of the order confirmation amendment is rejected. ConfirmationRejectedStatus1 - Collection 1..10
Status Status of the order confirmation is accepted or received or sent to next party or there is a communication problem with next party. There is no reason attached. OrderConfirmationStatus1Code - Required 1..1
StatusInitiator Party that initiates the status of the order confirmation. IPartyIdentification2Choice - Optional 0..1
InvestmentAccountDetails Account information of the individual order confirmation for which the status is given. InvestmentAccount13 - Optional 0..1
FinancialInstrumentDetails Financial instrument information of the individual order confirmation for which the status is given. FinancialInstrument10 - 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 OrderConfirmationStatusReportV01 implementation follows a specific implementaiton pattern. First of all, OrderConfirmationStatusReportV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, OrderConfirmationStatusReportV01Document implements IOuterDocument. Because OrderConfirmationStatusReportV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type OrderConfirmationStatusReportV01.

classDiagram
    class IOuterRecord
    OrderConfirmationStatusReportV01 --|> IOuterRecord : Implements
    OrderConfirmationStatusReportV01Document --|> IOuterDocument~OrderConfirmationStatusReportV01~ : Implements
    class IOuterDocument~OrderConfirmationStatusReportV01~ {
        OrderConfirmationStatusReportV01 Message
     }

Document wrapper for serialization

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

classDiagram
    OrderConfirmationStatusReportV01Document *-- OrderConfirmationStatusReportV01 : 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.057.001.01">
    <OrdrConfStsRptV01>
        <MsgId>
            <!-- MessageIdentification inner content -->
        </MsgId>
        <OthrRef>
            <!-- OtherReference inner content -->
        </OthrRef>
        <RltdRef>
            <!-- RelatedReference inner content -->
        </RltdRef>
        <IndvOrdrConfDtlsRpt>
            <!-- IndividualOrderConfirmationDetailsReport inner content -->
        </IndvOrdrConfDtlsRpt>
        <Xtnsn>
            <!-- Extension inner content -->
        </Xtnsn>
    </OrdrConfStsRptV01>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_hzzSMNE7Ed-BzquC8wXy7w_-354500985"
  nextVersions="_Aab8NTbLEead9bDRE_1DAQ"
  name="OrderConfirmationStatusReportV01"
  definition="Scope&#xD;&#xA;An instructing party, for example, an investment manager or its authorised representative, sends the OrderConfirmationStatusReport message to the executing party, for example, a transfer agent, to report the status of an order confirmation or an order confirmation amendment.&#xD;&#xA;Usage&#xD;&#xA;The OrderConfirmationStatusReport message is used to report on the status of one or more individual:&#xD;&#xA;- subscription confirmations,&#xD;&#xA;- subscription confirmation amendments,&#xD;&#xA;- redemption confirmations,&#xD;&#xA;- redemption confirmation amendments,&#xD;&#xA;- switch order confirmations,&#xD;&#xA;- switch order confirmation amendments.&#xD;&#xA;One of the following statuses can be reported:&#xD;&#xA;- confirmation rejected, or,&#xD;&#xA;- amendment rejected, or,&#xD;&#xA;- sent to next party, or,&#xD;&#xA;- communication problem with next party, or,&#xD;&#xA;- confirmation accepted, or,&#xD;&#xA;- confirmation received.&#xD;&#xA;It is likely that the OrderConfirmationStatusReport is only sent by the order instructing party to the order executing party to reject an order confirmation or to reject an order confirmation amendment, although if an intermediary party is used, the statuses sent to next party and communication problem with next party are also likely be used. The statuses confirmation accepted and confirmation received would only be used in the event the order executing party sends a RequestForOrderConfirmationStatusReport message and one of the other statuses does not apply.&#xD;&#xA;If the status being reported is either confirmation rejected or amendment rejected, then a reason for the rejection must be given.&#xD;&#xA;The individual order confirmation or confirmation amendment for which the status is given is identified with its order reference. The message identification of the message in which the individual order confirmation or confirmation amendment was conveyed may also be quoted in RelatedReference, but this is not recommended."
  registrationStatus="Registered"
  messageSet="_wFQdsE2rEeG_I4xRYCA_7g"
  xmlTag="OrdrConfStsRptV01"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_hzzSOdE7Ed-BzquC8wXy7w_1190327116"
    name="RelatedReferenceGuideline"
    definition="If RelatedReference/MessageName is present, it must contain 515 or must start with setr.003, setr.006, setr.009, setr.012, setr.015, setr.047, setr.048, setr.049, setr.050, setr.051, setr.052, setr.053, setr.054, setr.055,setr.056 or setr.058 and RelatedReference/Reference must contain the reference of a message in this list."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_hz9DMtE7Ed-BzquC8wXy7w_-1382729678"
    name="OtherReferenceGuideline"
    definition="OtherReference should be used to reference an order confirmation, order confirmation cancellation or order confirmation amendment 'message' sent in a proprietary way or used for a system reference. If OtherReference is present, OtherReference/MessageName must contain 'fax' or 'phone' or 'email', etc."
    registrationStatus="Provisionally Registered" />
  <xors
    xmi:id="_hzzSNtE7Ed-BzquC8wXy7w_-1496320853"
    name="RelatedReferenceOrOtherReferenceRule"
    definition="Occurrences of either RelatedReference or OtherReference may be present, but not occurrences of both."
    registrationStatus="Provisionally Registered"
    impactedMessageBuildingBlocks="_hzzSMtE7Ed-BzquC8wXy7w_-1840795261 _hzzSM9E7Ed-BzquC8wXy7w_1545429452" />
  <messageBuildingBlock
    xmi:id="_hzzSMdE7Ed-BzquC8wXy7w_1729546836"
    nextVersions="_Aab8PTbLEead9bDRE_1DAQ"
    name="MessageIdentification"
    definition="Reference that uniquely identifies a message from a business application standpoint."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_hzzSMtE7Ed-BzquC8wXy7w_-1840795261"
    name="OtherReference"
    definition="Reference to a linked message sent in a proprietary way or reference of a system."
    registrationStatus="Provisionally Registered"
    maxOccurs="2"
    minOccurs="0"
    xmlTag="OthrRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_hzzSM9E7Ed-BzquC8wXy7w_1545429452"
    name="RelatedReference"
    definition="Reference to a linked message that was previously received."
    registrationStatus="Provisionally Registered"
    maxOccurs="2"
    minOccurs="0"
    xmlTag="RltdRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_hzzSNNE7Ed-BzquC8wXy7w_1394750346"
    nextVersions="_Aab8QzbLEead9bDRE_1DAQ"
    name="IndividualOrderConfirmationDetailsReport"
    definition="Status report details of an individual order confirmation."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="IndvOrdrConfDtlsRpt"
    complexType="_RMoJOdp-Ed-ak6NoX_4Aeg_-1768968908" />
  <messageBuildingBlock
    xmi:id="_hzzSNdE7Ed-BzquC8wXy7w_1567010081"
    nextVersions="_Aab8RTbLEead9bDRE_1DAQ"
    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="057"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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