StatusChangeRequestV02

tsmt.026.001.02

Scope The StatusChangeRequest message is sent by a party involved in a transaction to the matching application. This message is used to request a change in the status of a transaction. Usage The StatusChangeRequest message can be sent by either party involved in a transaction to the matching application to request a change in the status of a transaction. The matching application will pass on the request by sending a StatusChangeRequestNotification message to the counterparty which can accept or reject the request by sending a SatausChangeRequestAcceptance or StatusChangeRequestRejection message.

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
%% StatusChangeRequestV02 recursion level 0 with max 0
StatusChangeRequestV02 *-- "1..1" MessageIdentification1 : RequestIdentification
StatusChangeRequestV02 *-- "1..1" SimpleIdentificationInformation : TransactionIdentification
StatusChangeRequestV02 *-- "0..1" SimpleIdentificationInformation : SubmitterTransactionReference
StatusChangeRequestV02 *-- "1..1" TransactionStatus3 : RequestedStatus
StatusChangeRequestV02 *-- "0..1" Reason2 : RequestReason
  

Now, we will zero-in one-by-one on each of these building blocks.

RequestIdentification building block

Identifies the request message. 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

TransactionIdentification building block

Unique identification assigned by the matching application to the transaction. This identification is to be used in any communication between the parties. Information related to an identification, eg, party identification or account identification. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SimpleIdentificationInformation recursion level 0 with max 1
class SimpleIdentificationInformation{
    Identification IsoMax35Text
}
  

SimpleIdentificationInformation members

SubmitterTransactionReference building block

Reference to the transaction for the requesting financial institution. Information related to an identification, eg, party identification or account identification. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SimpleIdentificationInformation recursion level 0 with max 1
class SimpleIdentificationInformation{
    Identification IsoMax35Text
}
  

SimpleIdentificationInformation members

RequestedStatus building block

Specifies the baseline status requested by the submitter by means of a code. Identifies the status of the transaction by means of a code. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% TransactionStatus3 recursion level 0 with max 1
class TransactionStatus3{
    Status BaselineStatus2Code
}
  

TransactionStatus3 members

RequestReason building block

Specifies the reason for the request to change status. Specifies the reason for an action. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Reason2 recursion level 0 with max 1
class Reason2{
    Description IsoMax140Text
}
  

Reason2 members

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the StatusChangeRequestV02 implementation follows a specific implementaiton pattern. First of all, StatusChangeRequestV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, StatusChangeRequestV02Document implements IOuterDocument. Because StatusChangeRequestV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type StatusChangeRequestV02.

classDiagram
    class IOuterRecord
    StatusChangeRequestV02 --|> IOuterRecord : Implements
    StatusChangeRequestV02Document --|> IOuterDocument~StatusChangeRequestV02~ : Implements
    class IOuterDocument~StatusChangeRequestV02~ {
        StatusChangeRequestV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    StatusChangeRequestV02Document *-- StatusChangeRequestV02 : 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:tsmt.026.001.02">
    <StsChngReq>
        <ReqId>
            <!-- RequestIdentification inner content -->
        </ReqId>
        <TxId>
            <!-- TransactionIdentification inner content -->
        </TxId>
        <SubmitrTxRef>
            <!-- SubmitterTransactionReference inner content -->
        </SubmitrTxRef>
        <ReqdSts>
            <!-- RequestedStatus inner content -->
        </ReqdSts>
        <ReqRsn>
            <!-- RequestReason inner content -->
        </ReqRsn>
    </StsChngReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_xjvgaNE8Ed-BzquC8wXy7w_-2117703681"
  name="StatusChangeRequestV02"
  definition="Scope&#xD;&#xA;The StatusChangeRequest message is sent by a party involved in a transaction to the matching application.&#xD;&#xA;This message is used to request a change in the status of a transaction.&#xD;&#xA;Usage&#xD;&#xA;The StatusChangeRequest message can be sent by either party involved in a transaction to the matching application to request a change in the status of a transaction.&#xD;&#xA;The matching application will pass on the request by sending a StatusChangeRequestNotification message to the counterparty which can accept or reject the request by sending a SatausChangeRequestAcceptance or StatusChangeRequestRejection message."
  registrationStatus="Registered"
  messageSet="_wRx2yk2rEeG_I4xRYCA_7g _1a374FXOEeOkkLyrDUP66g"
  xmlTag="StsChngReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_xjvgadE8Ed-BzquC8wXy7w_-2117703678"
    name="RequestIdentification"
    definition="Identifies the request message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="ReqId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_xjvgatE8Ed-BzquC8wXy7w_-2117703649"
    name="TransactionIdentification"
    definition="Unique identification assigned by the matching application to the transaction.&#xA;This identification is to be used in any communication between the parties."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="TxId"
    complexType="_P-ile9p-Ed-ak6NoX_4Aeg_745508310" />
  <messageBuildingBlock
    xmi:id="_xjvga9E8Ed-BzquC8wXy7w_-2117703588"
    name="SubmitterTransactionReference"
    definition="Reference to the transaction for the requesting financial institution."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SubmitrTxRef"
    complexType="_P-ile9p-Ed-ak6NoX_4Aeg_745508310" />
  <messageBuildingBlock
    xmi:id="_xjvgbNE8Ed-BzquC8wXy7w_-2117703618"
    name="RequestedStatus"
    definition="Specifies the baseline status requested by the submitter by means of a code."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="ReqdSts"
    complexType="_RKFyk9p-Ed-ak6NoX_4Aeg_-489445133" />
  <messageBuildingBlock
    xmi:id="_xjvgbdE8Ed-BzquC8wXy7w_-2117703557"
    name="RequestReason"
    definition="Specifies the reason for the request to change status."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="ReqRsn"
    complexType="_RJ8oo9p-Ed-ak6NoX_4Aeg_949144780" />
  <messageDefinitionIdentifier
    businessArea="tsmt"
    messageFunctionality="026"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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