Iso20022

OrderCancellationStatusReportV03

setr.017.001.03

Scope An executing party, for example, a transfer agent, sends the OrderCancellationStatusReport to the instructing party, for example, an investment manager or its authorised representative, to report the status of an order cancellation request that was previously received. Usage The OrderCancellationStatusReport message is used to provide the status of:

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
%% OrderCancellationStatusReportV03 recursion level 0 with max 0
OrderCancellationStatusReportV03 *-- "1..1" MessageIdentification1 : MessageIdentification
OrderCancellationStatusReportV03 *-- "0..2" AdditionalReference3 : RelatedReference
OrderCancellationStatusReportV03 *-- "0..2" AdditionalReference3 : OtherReference
OrderCancellationStatusReportV03 *-- "1..1" OrderStatusAndReason8 : CancellationStatusReport
OrderCancellationStatusReportV03 *-- "1..1" IndividualOrderStatusAndReason4 : IndividualCancellationStatusReport
OrderCancellationStatusReportV03 *-- "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

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

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

CancellationStatusReport building block

Status report details of a bulk or multiple or switch order cancellation message. Status report of a bulk or multiple or switch order cancellation instruction that was previously received. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% OrderStatusAndReason8 recursion level 0 with max 1
class OrderStatusAndReason8{
    MasterReference IsoMax35Text
    Status OrderCancellationStatus1Code
}
OrderStatusAndReason8 *-- "1..1" RejectedStatus7 : Rejected
OrderStatusAndReason8 *-- "0..1" IPartyIdentification2Choice : StatusInitiator
%% RejectedStatus7 recursion level 1 with max 1
class RejectedStatus7{
    Reason RejectedStatusReason8Code
    ExtendedReason IsoExtended350Code
}
RejectedStatus7 *-- "1..1" GenericIdentification1 : DataSourceScheme
%% IPartyIdentification2Choice recursion level 1 with max 1

OrderStatusAndReason8 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
Status Cancellation status of the order. OrderCancellationStatus1Code - Required 1..1
Rejected Status of the order cancellation request is rejected. RejectedStatus7 - Required 1..1
StatusInitiator Party that initiates the status of the order cancellation. IPartyIdentification2Choice - Optional 0..1

IndividualCancellationStatusReport building block

Status report details of one or more individual orders from a bulk or multiple or switch order cancellation request. Status report of an individual order of a bulk or multiple or switch order cancellation instruction that was previously received. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IndividualOrderStatusAndReason4 recursion level 0 with max 1
class IndividualOrderStatusAndReason4{
    MasterReference IsoMax35Text
    OrderReference IsoMax35Text
    ClientReference IsoMax35Text
    CancellationReference IsoMax35Text
    Status OrderCancellationStatus1Code
}
IndividualOrderStatusAndReason4 *-- "1..1" RejectedStatus7 : Rejected
IndividualOrderStatusAndReason4 *-- "0..1" IPartyIdentification2Choice : StatusInitiator
IndividualOrderStatusAndReason4 *-- "0..1" InvestmentAccount13 : InvestmentAccountDetails
IndividualOrderStatusAndReason4 *-- "0..1" FinancialInstrument10 : FinancialInstrumentDetails
%% RejectedStatus7 recursion level 1 with max 1
class RejectedStatus7{
    Reason RejectedStatusReason8Code
    ExtendedReason IsoExtended350Code
}
RejectedStatus7 *-- "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

IndividualOrderStatusAndReason4 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
CancellationReference Unique and unambiguous identifier for an order cancellation, as assigned by the instructing party. IsoMax35Text - Optional 0..1
Status Cancellation status of the order. OrderCancellationStatus1Code - Required 1..1
Rejected Status of the individual order cancellation request is rejected. RejectedStatus7 - Required 1..1
StatusInitiator Party that initiates the status of the individual order cancellation. IPartyIdentification2Choice - Optional 0..1
InvestmentAccountDetails Account information of the individual order cancellation for which the status is given. InvestmentAccount13 - Optional 0..1
FinancialInstrumentDetails Financial instrument information of the individual order cancellation 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 OrderCancellationStatusReportV03 implementation follows a specific implementaiton pattern. First of all, OrderCancellationStatusReportV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, OrderCancellationStatusReportV03Document implements IOuterDocument. Because OrderCancellationStatusReportV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type OrderCancellationStatusReportV03.

classDiagram
    class IOuterRecord
    OrderCancellationStatusReportV03 --|> IOuterRecord : Implements
    OrderCancellationStatusReportV03Document --|> IOuterDocument~OrderCancellationStatusReportV03~ : Implements
    class IOuterDocument~OrderCancellationStatusReportV03~ {
        OrderCancellationStatusReportV03 Message
     }

Document wrapper for serialization

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

classDiagram
    OrderCancellationStatusReportV03Document *-- OrderCancellationStatusReportV03 : 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.017.001.03">
    <OrdrCxlStsRptV03>
        <MsgId>
            <!-- MessageIdentification inner content -->
        </MsgId>
        <RltdRef>
            <!-- RelatedReference inner content -->
        </RltdRef>
        <OthrRef>
            <!-- OtherReference inner content -->
        </OthrRef>
        <CxlStsRpt>
            <!-- CancellationStatusReport inner content -->
        </CxlStsRpt>
        <IndvCxlStsRpt>
            <!-- IndividualCancellationStatusReport inner content -->
        </IndvCxlStsRpt>
        <Xtnsn>
            <!-- Extension inner content -->
        </Xtnsn>
    </OrdrCxlStsRptV03>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_g9jmudE7Ed-BzquC8wXy7w_-1949489273"
  nextVersions="_Aab7PTbLEead9bDRE_1DAQ"
  previousVersion="_gilh-NE7Ed-BzquC8wXy7w_-1859459709"
  name="OrderCancellationStatusReportV03"
  definition="Scope&#xD;&#xA;An executing party, for example, a transfer agent, sends the OrderCancellationStatusReport to the instructing party, for example, an investment manager or its authorised representative, to report the status of an order cancellation request that was previously received.&#xD;&#xA;Usage&#xD;&#xA;The OrderCancellationStatusReport message is used to provide the status of:&#xD;&#xA;- one or more individual order cancellation requests by using IndividualCancellationStatusReport, or,&#xD;&#xA;- an order cancellation request message by using CancellationStatusReport.&#xD;&#xA;If the OrderCancellationStatusReport message is used to report the status of an individual order cancellation request, then the repetitive IndividualCancellationStatusReport sequence is used and the order reference of the individual order is quoted in OrderReference. The message identification of the message in which the individual order was conveyed may also be quoted in RelatedReference.&#xD;&#xA;If the OrderCancellationStatusReport message is used to report the status of an entire order cancellation request message, for example, the SubscriptionBulkOrderCancellationRequest, or a SubscriptionOrderCancellationRequest containing several orders, then the CancellationStatusReport sequence. is used and the message identification of the order cancellation request message is quoted in RelatedReference. All the order cancellation requests within the message must have the same status.&#xD;&#xA;One of the following statuses can be reported:&#xD;&#xA;- the order cancellation is pending, or,&#xD;&#xA;- the order cancellation request is rejected, or,&#xD;&#xA;- the order is cancelled.&#xD;&#xA;When the cancellation is rejected, the reason for the rejection must be specified."
  registrationStatus="Registered"
  messageSet="_wFQdsE2rEeG_I4xRYCA_7g"
  xmlTag="OrdrCxlStsRptV03"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_g9tXuNE7Ed-BzquC8wXy7w_-1949488841"
    name="MessageNameAndReferenceGuideline"
    definition="If RelatedReference/MessageName or OtherReference/MessageName is present, it must contain 502 or must start with setr.002, setr.005, setr.008, setr.011, setr.014 or setr.018 and RelatedReference/Reference must contain the message reference of a message in this list."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_g9tXu9E7Ed-BzquC8wXy7w_2058450012"
    name="OtherReferenceGuideline"
    definition="OtherReference should be used to reference an order cancellation '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="_g9tXstE7Ed-BzquC8wXy7w_-1949488798"
    name="RelatedReferenceOrOtherReferenceRule"
    definition="Occurrences of either RelatedReference or OtherReference may be present, but not occurrences of both."
    registrationStatus="Provisionally Registered"
    impactedMessageBuildingBlocks="_g9jmu9E7Ed-BzquC8wXy7w_-1949489212 _g9jmvNE7Ed-BzquC8wXy7w_-1949488875" />
  <xors
    xmi:id="_g9tXtdE7Ed-BzquC8wXy7w_540233025"
    name="CancellationOrIndividualCancellationStatusReportRule"
    definition="Either CancellationStatusReport or at least one occurrence of IndividualCancellationStatusReport must be present, but not both."
    registrationStatus="Provisionally Registered"
    impactedMessageBuildingBlocks="_g9jmvdE7Ed-BzquC8wXy7w_-1949488917 _g9tXsNE7Ed-BzquC8wXy7w_-358353694" />
  <messageBuildingBlock
    xmi:id="_g9jmutE7Ed-BzquC8wXy7w_-1666125057"
    nextVersions="_Aab7RzbLEead9bDRE_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="_g9jmu9E7Ed-BzquC8wXy7w_-1949489212"
    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="_g9jmvNE7Ed-BzquC8wXy7w_-1949488875"
    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="_g9jmvdE7Ed-BzquC8wXy7w_-1949488917"
    name="CancellationStatusReport"
    definition="Status report details of a bulk or multiple or switch order cancellation message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CxlStsRpt"
    complexType="_RL4iV9p-Ed-ak6NoX_4Aeg_-1721469450" />
  <messageBuildingBlock
    xmi:id="_g9tXsNE7Ed-BzquC8wXy7w_-358353694"
    name="IndividualCancellationStatusReport"
    definition="Status report details of one or more individual orders from a bulk or multiple or switch order cancellation request."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="IndvCxlStsRpt"
    complexType="_RMeYPNp-Ed-ak6NoX_4Aeg_-887862240" />
  <messageBuildingBlock
    xmi:id="_g9tXsdE7Ed-BzquC8wXy7w_819197774"
    nextVersions="_Aab7UTbLEead9bDRE_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="017"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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