auth.011.001.01
Scope A regulator or an intermediary sends the RegulatoryTransactionReportCancellationStatus to a reporting institution to provide the status of a RegulatoryTransactionReportCancellationRequest previously sent by the reporting institution. Usage The message definition may be used to provide a status for the entire report or to provide a status at the level of individual transactions within the report. One of the following statuses can be reported:
- Completed, or,
- Pending, or,
- Rejected. If the status is rejected, then reason for the rejection must be specified.
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
%% RegulatoryTransactionReportCancellationStatusV01 recursion level 0 with max 0
RegulatoryTransactionReportCancellationStatusV01 *-- "1..1" DocumentIdentification8 : Identification
RegulatoryTransactionReportCancellationStatusV01 *-- "1..1" IPartyIdentification23Choice : ReportingInstitution
RegulatoryTransactionReportCancellationStatusV01 *-- "1..1" ReportStatusAndReason2 : ReportCancellationStatus
RegulatoryTransactionReportCancellationStatusV01 *-- "1..1" TradeTransactionStatusAndReason2 : IndividualTransactionCancellationStatus
Now, we will zero-in one-by-one on each of these building blocks.
Identification building block
Identification of the RegulatoryTransactionReportCancellationStatus document. Identifies the document by providing a unique identification and optionally the date/time of the creation of the document. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% DocumentIdentification8 recursion level 0 with max 1
class DocumentIdentification8{
Identification IsoMax35Text
CreationDateTime IsoISODateTime
}
DocumentIdentification8 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Identification | Unique identification of the document. | IsoMax35Text - Required 1..1 |
| CreationDateTime | Date/time of the creation of the document. | IsoISODateTime - Optional 0..1 |
ReportingInstitution building block
Identification of the firm that executed the transaction. Choice of identification of a party. The party can be identified by giving a BIC or a proprietary code. For comparison, see the ISO20022 official specification
classDiagram direction tb %% IPartyIdentification23Choice recursion level 0 with max 1
PartyIdentification23Choice members
| Member name | Description | Data Type / Multiplicity |
|---|
ReportCancellationStatus building block
Provides the status of the entire RegulatoryTransactionReportCancellationRequest document that was previously sent by a reporting institution.
. Provides the related report identification and its status. If the status is rejected, a reason for this status must be given. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ReportStatusAndReason2 recursion level 0 with max 1
class ReportStatusAndReason2{
RelatedReference IsoMax35Text
Status Status2Code
}
ReportStatusAndReason2 *-- "1..100" IRejectedCancellationStatusReason1Choice : Rejected
%% IRejectedCancellationStatusReason1Choice recursion level 1 with max 1
ReportStatusAndReason2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| RelatedReference | Provides the identification of the RegulatoryTransactionReportCancellationRequest document that was previously sent by the reporting institution. | IsoMax35Text - Required 1..1 |
| Status | Indicates the status of a report cancellation request message. | Status2Code - Required 1..1 |
| Rejected | Indicates that the cancellation is rejected and provides a reason why. | IRejectedCancellationStatusReason1Choice - Collection 1..100 |
IndividualTransactionCancellationStatus building block
Provides the cancellation status of one or more transactions within a RegulatoryTransactionReportCancellationRequest that was previously sent by a reporting institution. Identifies the transaction with a trade reference and provides its status. If the status is rejected, a reason for this status must be given. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% TradeTransactionStatusAndReason2 recursion level 0 with max 1
class TradeTransactionStatusAndReason2{
RelatedReference IsoMax35Text
TradeReference IsoMax70Text
Status Status2Code
}
TradeTransactionStatusAndReason2 *-- "1..100" IRejectedCancellationStatusReason1Choice : Rejected
%% IRejectedCancellationStatusReason1Choice recursion level 1 with max 1
TradeTransactionStatusAndReason2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| RelatedReference | Provides the identification of the RegulatoryTransactionReportCancellationRequest document that was previously sent by the reporting institution. | IsoMax35Text - Required 1..1 |
| TradeReference | Unique identification assigned to a trade once it is received or matched by an executing system. | IsoMax70Text - Required 1..1 |
| Status | Indicates the status of an instruction, request or report message. | Status2Code - Required 1..1 |
| Rejected | Indicates that the cancellation is rejected and provides a reason why. | IRejectedCancellationStatusReason1Choice - Collection 1..100 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the RegulatoryTransactionReportCancellationStatusV01 implementation follows a specific implementaiton pattern. First of all, RegulatoryTransactionReportCancellationStatusV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, RegulatoryTransactionReportCancellationStatusV01Document implements IOuterDocument. Because RegulatoryTransactionReportCancellationStatusV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type RegulatoryTransactionReportCancellationStatusV01.
classDiagram
class IOuterRecord
RegulatoryTransactionReportCancellationStatusV01 --|> IOuterRecord : Implements
RegulatoryTransactionReportCancellationStatusV01Document --|> IOuterDocument~RegulatoryTransactionReportCancellationStatusV01~ : Implements
class IOuterDocument~RegulatoryTransactionReportCancellationStatusV01~ {
RegulatoryTransactionReportCancellationStatusV01 Message
}
Document wrapper for serialization
The only real purpose RegulatoryTransactionReportCancellationStatusV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:auth.011.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using RegulatoryTransactionReportCancellationStatusV01.ToDocument() method. The returned RegulatoryTransactionReportCancellationStatusV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
RegulatoryTransactionReportCancellationStatusV01Document *-- RegulatoryTransactionReportCancellationStatusV01 : 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:auth.011.001.01">
<RgltryTxRptCxlStsV01>
<Id>
<!-- Identification inner content -->
</Id>
<RptgInstn>
<!-- ReportingInstitution inner content -->
</RptgInstn>
<RptCxlSts>
<!-- ReportCancellationStatus inner content -->
</RptCxlSts>
<IndvTxCxlSts>
<!-- IndividualTransactionCancellationStatus inner content -->
</IndvTxCxlSts>
</RgltryTxRptCxlStsV01>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_gJrQAcIFEeGllrOKQRUTYA_-231568037"
name="RegulatoryTransactionReportCancellationStatusV01"
definition="Scope
A regulator or an intermediary sends the RegulatoryTransactionReportCancellationStatus to a reporting institution to provide the status of a RegulatoryTransactionReportCancellationRequest previously sent by the reporting institution.
Usage
The message definition may be used to provide a status for the entire report or to provide a status at the level of individual transactions within the report. One of the following statuses can be reported:
- Completed, or,
- Pending, or,
- Rejected.
If the status is rejected, then reason for the rejection must be specified."
registrationStatus="Registered"
messageSet="_wRoFwU2rEeG_I4xRYCA_7g"
xmlTag="RgltryTxRptCxlStsV01"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<xors
xmi:id="_gJ1BAMIFEeGllrOKQRUTYA_-67650141"
name="ReportCancellationStatusOrIndividualTransactionCancellationStatusRule"
definition="Either ReportCancellationStatus or IndividualTransactionCancellationStatus must be present, but not both."
registrationStatus="Provisionally Registered"
impactedMessageBuildingBlocks="_gJrQBMIFEeGllrOKQRUTYA_-1473248173 _gJrQBcIFEeGllrOKQRUTYA_-1483406141" />
<messageBuildingBlock
xmi:id="_gJrQAsIFEeGllrOKQRUTYA_1165719728"
name="Identification"
definition="Identification of the RegulatoryTransactionReportCancellationStatus document."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Id"
complexType="_RXNBiNp-Ed-ak6NoX_4Aeg_-320016249" />
<messageBuildingBlock
xmi:id="_gJrQA8IFEeGllrOKQRUTYA_1815879851"
name="ReportingInstitution"
definition="Identification of the firm that executed the transaction."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RptgInstn"
complexType="_QReIgdp-Ed-ak6NoX_4Aeg_-1086683076" />
<messageBuildingBlock
xmi:id="_gJrQBMIFEeGllrOKQRUTYA_-1473248173"
name="ReportCancellationStatus"
definition="Provides the status of the entire RegulatoryTransactionReportCancellationRequest document that was previously sent by a reporting institution.

."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RptCxlSts"
complexType="_RXgjgNp-Ed-ak6NoX_4Aeg_167456466" />
<messageBuildingBlock
xmi:id="_gJrQBcIFEeGllrOKQRUTYA_-1483406141"
name="IndividualTransactionCancellationStatus"
definition="Provides the cancellation status of one or more transactions within a RegulatoryTransactionReportCancellationRequest that was previously sent by a reporting institution."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="IndvTxCxlSts"
complexType="_RXgjh9p-Ed-ak6NoX_4Aeg_587723747" />
<messageDefinitionIdentifier
businessArea="auth"
messageFunctionality="011"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.