tsmt.028.001.03
Scope The StatusChangeRequestNotification message is sent by the matching application to the party requested to accept or reject the request of a change in the status of a transaction. This message is used to notify the request of a change in the status of a transaction. Usage The StatusChangeRequestNotification message can be sent by the matching application to pass on the information about the request of a change in the status of a transaction that it has obtained through the receipt of a StatusChangeRequest 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 %% StatusChangeRequestNotificationV03 recursion level 0 with max 0 StatusChangeRequestNotificationV03 *-- "1..1" MessageIdentification1 : NotificationIdentification StatusChangeRequestNotificationV03 *-- "1..1" SimpleIdentificationInformation : TransactionIdentification StatusChangeRequestNotificationV03 *-- "0..1" DocumentIdentification3 : EstablishedBaselineIdentification StatusChangeRequestNotificationV03 *-- "1..1" TransactionStatus4 : TransactionStatus StatusChangeRequestNotificationV03 *-- "0..2" DocumentIdentification5 : UserTransactionReference StatusChangeRequestNotificationV03 *-- "1..1" TransactionStatus3 : ProposedStatusChange StatusChangeRequestNotificationV03 *-- "0..1" Reason2 : RequestReason StatusChangeRequestNotificationV03 *-- "1..1" BICIdentification1 : Initiator StatusChangeRequestNotificationV03 *-- "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 |
ProposedStatusChange building block
Specifies the status that is proposed by the other party. 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
Member name | Description | Data Type / Multiplicity |
---|---|---|
Status | Identifies the status of the transaction by means of a code. | BaselineStatus2Code - Required 1..1 |
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
Member name | Description | Data Type / Multiplicity |
---|---|---|
Description | Detailed description of the rejection. | IsoMax140Text - Required 1..1 |
Initiator building block
Party that has requested the status change. Unique and unambiguous identifier of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. For comparison, see the ISO20022 official specification
classDiagram direction tb %% BICIdentification1 recursion level 0 with max 1 class BICIdentification1{ BIC IsoBICIdentifier }
BICIdentification1 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
BIC | Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 “Banking - Banking telecommunication messages - Business identifier code (BIC)”. | IsoBICIdentifier - 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 StatusChangeRequestNotificationV03 implementation follows a specific implementaiton pattern. First of all, StatusChangeRequestNotificationV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, StatusChangeRequestNotificationV03Document implements IOuterDocument. Because StatusChangeRequestNotificationV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type StatusChangeRequestNotificationV03.
classDiagram class IOuterRecord StatusChangeRequestNotificationV03 --|> IOuterRecord : Implements StatusChangeRequestNotificationV03Document --|> IOuterDocument~StatusChangeRequestNotificationV03~ : Implements class IOuterDocument~StatusChangeRequestNotificationV03~ { StatusChangeRequestNotificationV03 Message }
Document wrapper for serialization
The only real purpose StatusChangeRequestNotificationV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:tsmt.028.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using StatusChangeRequestNotificationV03.ToDocument() method. The returned StatusChangeRequestNotificationV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram StatusChangeRequestNotificationV03Document *-- StatusChangeRequestNotificationV03 : 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.028.001.03">
<StsChngReqNtfctn>
<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>
<PropsdStsChng>
<!-- ProposedStatusChange inner content -->
</PropsdStsChng>
<ReqRsn>
<!-- RequestReason inner content -->
</ReqRsn>
<Initr>
<!-- Initiator inner content -->
</Initr>
<ReqForActn>
<!-- RequestForAction inner content -->
</ReqForActn>
</StsChngReqNtfctn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_wSYmONE8Ed-BzquC8wXy7w_439569273"
name="StatusChangeRequestNotificationV03"
definition="Scope
The StatusChangeRequestNotification message is sent by the matching application to the party requested to accept or reject the request of a change in the status of a transaction.
This message is used to notify the request of a change in the status of a transaction.
Usage
The StatusChangeRequestNotification message can be sent by the matching application to pass on the information about the request of a change in the status of a transaction that it has obtained through the receipt of a StatusChangeRequest message."
registrationStatus="Registered"
messageSet="_wRx2yk2rEeG_I4xRYCA_7g _1a374FXOEeOkkLyrDUP66g"
xmlTag="StsChngReqNtfctn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_wSiXMNE8Ed-BzquC8wXy7w_439570377"
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="_wSiXMdE8Ed-BzquC8wXy7w_439570119"
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="_wSiXMtE8Ed-BzquC8wXy7w_439570205"
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="_wSiXM9E8Ed-BzquC8wXy7w_439569698"
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="_wSiXNNE8Ed-BzquC8wXy7w_439569386"
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="_wSiXNdE8Ed-BzquC8wXy7w_439569777"
name="ProposedStatusChange"
definition="Specifies the status that is proposed by the other party."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="PropsdStsChng"
complexType="_RKFyk9p-Ed-ak6NoX_4Aeg_-489445133" />
<messageBuildingBlock
xmi:id="_wSiXNtE8Ed-BzquC8wXy7w_439570689"
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" />
<messageBuildingBlock
xmi:id="_wSiXN9E8Ed-BzquC8wXy7w_1643841205"
name="Initiator"
definition="Party that has requested the status change."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Initr"
complexType="_QEp0kNp-Ed-ak6NoX_4Aeg_792527554" />
<messageBuildingBlock
xmi:id="_wSiXONE8Ed-BzquC8wXy7w_439569309"
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="028"
flavour="001"
version="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.