SpecialRequestV01

tsmt.047.001.01

Scope The SpecialRequest message is sent by a party to the transaction to the matching application if special circumstances are such that it cannot take part any longer to a specific transaction or that it cannot fulfill its role in the transaction. Usage The SpecialRequest message can be sent at any time during the life time of a transaction as long as the transaction is established and not yet closed.

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
%% SpecialRequestV01 recursion level 0 with max 0
SpecialRequestV01 *-- "1..1" MessageIdentification1 : RequestIdentification
SpecialRequestV01 *-- "1..1" SimpleIdentificationInformation : TransactionIdentification
SpecialRequestV01 *-- "0..1" SimpleIdentificationInformation : SubmitterTransactionReference
SpecialRequestV01 *-- "1..1" Notification1 : Notification
  

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

RequestIdentification building block

Identifies the acceptance 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 identification of 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

Notification building block

Type and details of the notification. Structured information to be communicated to other parties in the transaction. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Notification1 recursion level 0 with max 1
class Notification1{
    Type NotificationType1Code
    AdditionalInformation IsoMax140Text
}
  

Notification1 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    SpecialRequestV01 --|> IOuterRecord : Implements
    SpecialRequestV01Document --|> IOuterDocument~SpecialRequestV01~ : Implements
    class IOuterDocument~SpecialRequestV01~ {
        SpecialRequestV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    SpecialRequestV01Document *-- SpecialRequestV01 : 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.047.001.01">
    <SpclReq>
        <ReqId>
            <!-- RequestIdentification inner content -->
        </ReqId>
        <TxId>
            <!-- TransactionIdentification inner content -->
        </TxId>
        <SubmitrTxRef>
            <!-- SubmitterTransactionReference inner content -->
        </SubmitrTxRef>
        <Ntfctn>
            <!-- Notification inner content -->
        </Ntfctn>
    </SpclReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_u_roONE8Ed-BzquC8wXy7w_-951439872"
  name="SpecialRequestV01"
  definition="Scope&#xD;&#xA;The SpecialRequest message is sent by a party to the transaction to the matching application if special circumstances are such that it cannot take part any longer to a specific transaction or that it cannot fulfill its role in the transaction.&#xD;&#xA;Usage&#xD;&#xA;The SpecialRequest message can be sent at any time during the life time of a transaction as long as the transaction is established and not yet closed."
  registrationStatus="Registered"
  messageSet="_wRx2yk2rEeG_I4xRYCA_7g _1a374FXOEeOkkLyrDUP66g"
  xmlTag="SpclReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_u_roOdE8Ed-BzquC8wXy7w_-951439426"
    name="RequestIdentification"
    definition="Identifies the acceptance message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="ReqId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_u_roOtE8Ed-BzquC8wXy7w_-951439751"
    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="_u_1ZMNE8Ed-BzquC8wXy7w_-951439253"
    name="SubmitterTransactionReference"
    definition="Reference to the identification of 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="_u_1ZMdE8Ed-BzquC8wXy7w_1653813874"
    name="Notification"
    definition="Type and details of the notification."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Ntfctn"
    complexType="_RaowA9p-Ed-ak6NoX_4Aeg_1225299644" />
  <messageDefinitionIdentifier
    businessArea="tsmt"
    messageFunctionality="047"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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