tsmt.025.001.03
Scope The StatusChangeNotification message is sent by the matching application to the parties involved in the change of the status of a transaction. This message is used to inform about the change of a status. Usage The StatusChangeNotification message can be sent by the matching application
- to the submitter of the request to change the status of a transaction to pass on the information about the acceptance of the request that it has obtained through the receipt of an StatusChangeRequestAcceptance message.
- to the accepter of a request to change the status of a transaction inform about the actual status of the transaction in response to a StatusChangeRequestAcceptance message.
- to either party involved in the establishment of a transaction to inform about the change of the status of the transaction to the status close. This can be done when the limit of possible attempts to establish the transaction has been reached or when unilaterally requested by one of the parties involved in the not yet established transaction.
- to either party involved in a transaction to inform about the change of the status of the transaction as announced in a TimeOutNotification message sent by the matching application prior to the StatusChangeNotification 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 %% StatusChangeNotificationV03 recursion level 0 with max 0 StatusChangeNotificationV03 *-- "1..1" MessageIdentification1 : NotificationIdentification StatusChangeNotificationV03 *-- "1..1" SimpleIdentificationInformation : TransactionIdentification StatusChangeNotificationV03 *-- "0..1" DocumentIdentification3 : EstablishedBaselineIdentification StatusChangeNotificationV03 *-- "1..1" TransactionStatus4 : TransactionStatus StatusChangeNotificationV03 *-- "0..2" DocumentIdentification5 : UserTransactionReference StatusChangeNotificationV03 *-- "0..1" PendingActivity2 : RequestForAction
Now, we will zero-in one-by-one on each of these building blocks.
NotificationIdentification building block
Identifies the notification 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
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 |
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
Member name | Description | Data Type / Multiplicity |
---|---|---|
Identification | Name or number assigned by an entity to enable recognition of that entity, eg, account identifier. | IsoMax35Text - Required 1..1 |
EstablishedBaselineIdentification building block
Unique identification assigned by the matching application to the baseline when it is established. Identifies a document by a unique identification and a version. For comparison, see the ISO20022 official specification
classDiagram direction tb %% DocumentIdentification3 recursion level 0 with max 1 class DocumentIdentification3{ Identification IsoMax35Text Version IsoNumber }
DocumentIdentification3 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Identification | Identification of a set of data. | IsoMax35Text - Required 1..1 |
Version | Unambiguous identification of the version of a set of data. Example: Version 1. | IsoNumber - Required 1..1 |
TransactionStatus building block
Identifies the status of the transaction 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 %% TransactionStatus4 recursion level 0 with max 1 class TransactionStatus4{ Status BaselineStatus3Code }
TransactionStatus4 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Status | Identifies the status of the transaction by means of a code. | BaselineStatus3Code - Required 1..1 |
UserTransactionReference building block
Reference to the transaction for each financial institution which is a party to the transaction. Identifies a document by a unique identification and its issuer. For comparison, see the ISO20022 official specification
classDiagram direction tb %% DocumentIdentification5 recursion level 0 with max 1 class DocumentIdentification5{ Identification IsoMax35Text } DocumentIdentification5 *-- "1..1" BICIdentification1 : IdentificationIssuer %% BICIdentification1 recursion level 1 with max 1 class BICIdentification1{ BIC IsoBICIdentifier }
DocumentIdentification5 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Identification | Identification of a set of data. | IsoMax35Text - Required 1..1 |
IdentificationIssuer | Uniquely identifies the financial institution which has issued the identification of the set of data by using a BIC. | BICIdentification1 - Required 1..1 |
RequestForAction building block
Information on the next processing step required. Specifies the event that require an action from one of the parties to the trade transaction. For comparison, see the ISO20022 official specification
classDiagram direction tb %% PendingActivity2 recursion level 0 with max 1 class PendingActivity2{ Type Action2Code Description IsoMax140Text }
PendingActivity2 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Type | Code which specifies the next course of action that the receiver of the message must take. | Action2Code - Required 1..1 |
Description | Further information on the course of action that the receiver of the message must take. | IsoMax140Text - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the StatusChangeNotificationV03 implementation follows a specific implementaiton pattern. First of all, StatusChangeNotificationV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, StatusChangeNotificationV03Document implements IOuterDocument. Because StatusChangeNotificationV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type StatusChangeNotificationV03.
classDiagram class IOuterRecord StatusChangeNotificationV03 --|> IOuterRecord : Implements StatusChangeNotificationV03Document --|> IOuterDocument~StatusChangeNotificationV03~ : Implements class IOuterDocument~StatusChangeNotificationV03~ { StatusChangeNotificationV03 Message }
Document wrapper for serialization
The only real purpose StatusChangeNotificationV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:tsmt.025.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using StatusChangeNotificationV03.ToDocument() method. The returned StatusChangeNotificationV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram StatusChangeNotificationV03Document *-- StatusChangeNotificationV03 : 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.025.001.03">
<StsChngNtfctn>
<NtfctnId>
<!-- NotificationIdentification inner content -->
</NtfctnId>
<TxId>
<!-- TransactionIdentification inner content -->
</TxId>
<EstblishdBaselnId>
<!-- EstablishedBaselineIdentification inner content -->
</EstblishdBaselnId>
<TxSts>
<!-- TransactionStatus inner content -->
</TxSts>
<UsrTxRef>
<!-- UserTransactionReference inner content -->
</UsrTxRef>
<ReqForActn>
<!-- RequestForAction inner content -->
</ReqForActn>
</StsChngNtfctn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_vbs12NE8Ed-BzquC8wXy7w_-1030664392"
name="StatusChangeNotificationV03"
definition="Scope
The StatusChangeNotification message is sent by the matching application to the parties involved in the change of the status of a transaction.
This message is used to inform about the change of a status.
Usage
The StatusChangeNotification message can be sent by the matching application
- to the submitter of the request to change the status of a transaction to pass on the information about the acceptance of the request that it has obtained through the receipt of an StatusChangeRequestAcceptance message.
- to the accepter of a request to change the status of a transaction inform about the actual status of the transaction in response to a StatusChangeRequestAcceptance message.
- to either party involved in the establishment of a transaction to inform about the change of the status of the transaction to the status close. This can be done when the limit of possible attempts to establish the transaction has been reached or when unilaterally requested by one of the parties involved in the not yet established transaction.
- to either party involved in a transaction to inform about the change of the status of the transaction as announced in a TimeOutNotification message sent by the matching application prior to the StatusChangeNotification message."
registrationStatus="Registered"
messageSet="_wRx2yk2rEeG_I4xRYCA_7g _1a374FXOEeOkkLyrDUP66g"
xmlTag="StsChngNtfctn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_vbs12dE8Ed-BzquC8wXy7w_-1030664113"
name="NotificationIdentification"
definition="Identifies the notification message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="NtfctnId"
complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
<messageBuildingBlock
xmi:id="_vbs12tE8Ed-BzquC8wXy7w_-1030664082"
name="TransactionIdentification"
definition="Unique identification assigned by the matching application to the transaction.
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="_vb1_wNE8Ed-BzquC8wXy7w_-1030664360"
name="EstablishedBaselineIdentification"
definition="Unique identification assigned by the matching application to the baseline when it is established."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="EstblishdBaselnId"
complexType="_RJNBwdp-Ed-ak6NoX_4Aeg_-1127047102" />
<messageBuildingBlock
xmi:id="_vb1_wdE8Ed-BzquC8wXy7w_-1030663959"
name="TransactionStatus"
definition="Identifies the status of the transaction by means of a code."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="TxSts"
complexType="_RbFb-Np-Ed-ak6NoX_4Aeg_1598523783" />
<messageBuildingBlock
xmi:id="_vb1_wtE8Ed-BzquC8wXy7w_-1030664021"
name="UserTransactionReference"
definition="Reference to the transaction for each financial institution which is a party to the transaction."
registrationStatus="Provisionally Registered"
maxOccurs="2"
minOccurs="0"
xmlTag="UsrTxRef"
complexType="_RJWLsdp-Ed-ak6NoX_4Aeg_-86119846" />
<messageBuildingBlock
xmi:id="_vb1_w9E8Ed-BzquC8wXy7w_-1030664051"
name="RequestForAction"
definition="Information on the next processing step required."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="ReqForActn"
complexType="_RaowBtp-Ed-ak6NoX_4Aeg_-888447978" />
<messageDefinitionIdentifier
businessArea="tsmt"
messageFunctionality="025"
flavour="001"
version="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.