AcknowledgementV03

tsmt.001.001.03

Scope The Acknowledgement message is sent by the matching application to the party from which it received a message. This message is used to acknowledge the receipt of a message by the matching application. Usage The Acknowledgement message can be sent to a party from which the matching application received a message to acknowledge the receipt of that message. The message is sent when the matching application does not send any other message in response to a received 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
%% AcknowledgementV03 recursion level 0 with max 0
AcknowledgementV03 *-- "1..1" MessageIdentification1 : AcknowledgementIdentification
AcknowledgementV03 *-- "0..1" SimpleIdentificationInformation : TransactionIdentification
AcknowledgementV03 *-- "0..1" DocumentIdentification3 : EstablishedBaselineIdentification
AcknowledgementV03 *-- "0..1" TransactionStatus4 : TransactionStatus
AcknowledgementV03 *-- "0..2" DocumentIdentification5 : UserTransactionReference
AcknowledgementV03 *-- "1..1" MessageIdentification1 : AcknowledgedMessageReference
AcknowledgementV03 *-- "0..1" PendingActivity2 : RequestForAction
  

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

AcknowledgementIdentification building block

Identifies the acknowledgement 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

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

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

UserTransactionReference building block

Reference to the transaction for the financial institution that is the sender of the acknowledged message. 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

AcknowledgedMessageReference building block

Reference to the identification of the acknowledged 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

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

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcknowledgementV03 --|> IOuterRecord : Implements
    AcknowledgementV03Document --|> IOuterDocument~AcknowledgementV03~ : Implements
    class IOuterDocument~AcknowledgementV03~ {
        AcknowledgementV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AcknowledgementV03Document *-- AcknowledgementV03 : 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.001.001.03">
    <Ack>
        <AckId>
            <!-- AcknowledgementIdentification inner content -->
        </AckId>
        <TxId>
            <!-- TransactionIdentification inner content -->
        </TxId>
        <EstblishdBaselnId>
            <!-- EstablishedBaselineIdentification inner content -->
        </EstblishdBaselnId>
        <TxSts>
            <!-- TransactionStatus inner content -->
        </TxSts>
        <UsrTxRef>
            <!-- UserTransactionReference inner content -->
        </UsrTxRef>
        <AckdMsgRef>
            <!-- AcknowledgedMessageReference inner content -->
        </AckdMsgRef>
        <ReqForActn>
            <!-- RequestForAction inner content -->
        </ReqForActn>
    </Ack>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_hJ9OiNE8Ed-BzquC8wXy7w_-2019493432"
  name="AcknowledgementV03"
  definition="Scope&#xD;&#xA;The Acknowledgement message is sent by the matching application to the party from which it received a message.&#xD;&#xA;This message is used to acknowledge the receipt of a message by the matching application.&#xD;&#xA;Usage&#xD;&#xA;The Acknowledgement message can be sent to a party from which the matching application received a message to acknowledge the receipt of that message. The message is sent when the matching application does not send any other message in response to a received message."
  registrationStatus="Registered"
  messageSet="_wRx2yk2rEeG_I4xRYCA_7g _1a374FXOEeOkkLyrDUP66g"
  xmlTag="Ack"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_hJ9OidE8Ed-BzquC8wXy7w_-2019493414"
    name="AcknowledgementIdentification"
    definition="Identifies the acknowledgement message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="AckId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_hKG_gNE8Ed-BzquC8wXy7w_-2019492484"
    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="0"
    xmlTag="TxId"
    complexType="_P-ile9p-Ed-ak6NoX_4Aeg_745508310" />
  <messageBuildingBlock
    xmi:id="_hKG_gdE8Ed-BzquC8wXy7w_-2019493025"
    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="_hKG_gtE8Ed-BzquC8wXy7w_-2019492904"
    name="TransactionStatus"
    definition="Identifies the status of the transaction by means of a code."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="TxSts"
    complexType="_RbFb-Np-Ed-ak6NoX_4Aeg_1598523783" />
  <messageBuildingBlock
    xmi:id="_hKG_g9E8Ed-BzquC8wXy7w_-2019492381"
    name="UserTransactionReference"
    definition="Reference to the transaction for the financial institution that is the sender of the acknowledged message."
    registrationStatus="Provisionally Registered"
    maxOccurs="2"
    minOccurs="0"
    xmlTag="UsrTxRef"
    complexType="_RJWLsdp-Ed-ak6NoX_4Aeg_-86119846" />
  <messageBuildingBlock
    xmi:id="_hKG_hNE8Ed-BzquC8wXy7w_-2019493336"
    name="AcknowledgedMessageReference"
    definition="Reference to the identification of the acknowledged message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="AckdMsgRef"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_hKG_hdE8Ed-BzquC8wXy7w_-2019492579"
    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="001"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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