Iso20022

StatusReportV02

catm.001.001.02

Informs the master terminal manager (MTM) or the terminal manager (TM) about the status of the acceptor system including the identification of the POI, its components and their installed versions.

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
%% StatusReportV02 recursion level 0 with max 0
StatusReportV02 *-- "1..1" Header4 : Header
StatusReportV02 *-- "1..1" StatusReport2 : StatusReport
StatusReportV02 *-- "1..1" ContentInformationType4 : SecurityTrailer

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

Header building block

Set of characteristics related to the transfer of the status report. Set of characteristics related to the transfer of transactions. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header4 recursion level 0 with max 1
class Header4{
    DownloadTransfer IsoTrueFalseIndicator
    FormatVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header4 *-- "1..1" GenericIdentification35 : InitiatingParty
Header4 *-- "0..1" GenericIdentification35 : RecipientParty
%% GenericIdentification35 recursion level 1 with max 1
class GenericIdentification35{
    Identification IsoMax35Text
    Type PartyType5Code
    Issuer PartyType6Code
    ShortName IsoMax35Text
}
%% GenericIdentification35 recursion level 1 with max 1
class GenericIdentification35{
    Identification IsoMax35Text
    Type PartyType5Code
    Issuer PartyType6Code
    ShortName IsoMax35Text
}

Header4 members

Member name Description Data Type / Multiplicity
DownloadTransfer Indicates if the file transfer is a download or an upload. IsoTrueFalseIndicator - Required 1..1
FormatVersion Version of file format. IsoMax6Text - Required 1..1
ExchangeIdentification Unique identification of an exchange occurrence. IsoMax3NumericText - Required 1..1
CreationDateTime Date and time at which the file or message was created. IsoISODateTime - Required 1..1
InitiatingParty Unique identification of the partner that has initiated the exchange. GenericIdentification35 - Required 1..1
RecipientParty Unique identification of the partner that is the recipient of the exchange. GenericIdentification35 - Optional 0..1

StatusReport building block

Status of the point of interaction (POI), its components and their installed versions. Status of the acceptor system containing the identification of the POI, its components and their installed versions. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% StatusReport2 recursion level 0 with max 1
StatusReport2 *-- "1..1" GenericIdentification35 : POIIdentification
StatusReport2 *-- "0..1" GenericIdentification35 : TerminalManagerIdentification
StatusReport2 *-- "1..0" TerminalManagementDataSet4 : DataSet
%% GenericIdentification35 recursion level 1 with max 1
class GenericIdentification35{
    Identification IsoMax35Text
    Type PartyType5Code
    Issuer PartyType6Code
    ShortName IsoMax35Text
}
%% GenericIdentification35 recursion level 1 with max 1
class GenericIdentification35{
    Identification IsoMax35Text
    Type PartyType5Code
    Issuer PartyType6Code
    ShortName IsoMax35Text
}
%% TerminalManagementDataSet4 recursion level 1 with max 1
class TerminalManagementDataSet4{
    SequenceCounter IsoMax9NumericText
}
TerminalManagementDataSet4 *-- "1..1" DataSetIdentification3 : Identification
TerminalManagementDataSet4 *-- "1..1" StatusReportContent2 : Content

StatusReport2 members

Member name Description Data Type / Multiplicity
POIIdentification Identification of the point of interaction for terminal management. GenericIdentification35 - Required 1..1
TerminalManagerIdentification Identification of the terminal management system (TMS) to contact for the maintenance. GenericIdentification35 - Optional 0..1
DataSet Data related to a status report of a point of interaction (POI). TerminalManagementDataSet4 - Unknown 1..0

SecurityTrailer building block

Trailer of the message containing a MAC or a digital signature. General cryptographic message syntax (CMS) containing protected data. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContentInformationType4 recursion level 0 with max 1
class ContentInformationType4{
    ContentType ContentType1Code
}
ContentInformationType4 *-- "0..1" EnvelopedData2 : EnvelopedData
ContentInformationType4 *-- "0..1" AuthenticatedData2 : AuthenticatedData
ContentInformationType4 *-- "0..1" SignedData2 : SignedData
ContentInformationType4 *-- "0..1" DigestedData2 : DigestedData
ContentInformationType4 *-- "0..1" NamedKeyEncryptedData2 : NamedKeyEncryptedData
%% EnvelopedData2 recursion level 1 with max 1
class EnvelopedData2{
    Version IsoNumber
}
EnvelopedData2 *-- "1..0" IRecipient2Choice : Recipient
EnvelopedData2 *-- "1..1" EncryptedContent2 : EncryptedContent
%% AuthenticatedData2 recursion level 1 with max 1
class AuthenticatedData2{
    Version IsoNumber
    MAC IsoMax35Binary
}
AuthenticatedData2 *-- "1..0" IRecipient2Choice : Recipient
AuthenticatedData2 *-- "1..1" AlgorithmIdentification3 : MACAlgorithm
AuthenticatedData2 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
%% SignedData2 recursion level 1 with max 1
class SignedData2{
    Version IsoNumber
    Certificate IsoMax3000Binary
}
SignedData2 *-- "1..0" AlgorithmIdentification5 : DigestAlgorithm
SignedData2 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
SignedData2 *-- "1..0" Signer2 : Signer
%% DigestedData2 recursion level 1 with max 1
class DigestedData2{
    Version IsoNumber
    Digest IsoMax140Text
}
DigestedData2 *-- "1..0" AlgorithmIdentification5 : DigestAlgorithm
DigestedData2 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
%% NamedKeyEncryptedData2 recursion level 1 with max 1
class NamedKeyEncryptedData2{
    Version IsoNumber
    KeyName IsoMax140Text
}
NamedKeyEncryptedData2 *-- "1..1" EncryptedContent2 : EncryptedContent

ContentInformationType4 members

Member name Description Data Type / Multiplicity
ContentType Type of data protection. ContentType1Code - Required 1..1
EnvelopedData Data protection by encryption, with a session key. EnvelopedData2 - Optional 0..1
AuthenticatedData Data protection by a message authentication code (MAC). AuthenticatedData2 - Optional 0..1
SignedData Data protected by digital signatures. SignedData2 - Optional 0..1
DigestedData Data protected by a digest. DigestedData2 - Optional 0..1
NamedKeyEncryptedData Data protection by encryption with a previously exchanged key identified by a name. NamedKeyEncryptedData2 - Optional 0..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    StatusReportV02 --|> IOuterRecord : Implements
    StatusReportV02Document --|> IOuterDocument~StatusReportV02~ : Implements
    class IOuterDocument~StatusReportV02~ {
        StatusReportV02 Message
     }

Document wrapper for serialization

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

classDiagram
    StatusReportV02Document *-- StatusReportV02 : 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:catm.001.001.02">
    <StsRpt>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <StsRpt>
            <!-- StatusReport inner content -->
        </StsRpt>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </StsRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_DLRuIQvfEeK9Xewg3qiFQA"
  nextVersions="_9sSXsTV9EeODSIIQsYYKhw"
  previousVersion="_8ki24OQWEeCGktPI9k4Dlw_716782601"
  name="StatusReportV02"
  definition="Informs the master terminal manager (MTM) or the terminal manager (TM) about the status of the acceptor system including the identification of the POI, its components and their installed versions."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="StsRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_DLRuIwvfEeK9Xewg3qiFQA"
    nextVersions="_9sSXszV9EeODSIIQsYYKhw"
    name="Header"
    definition="Set of characteristics related to the transfer of the status report."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_K8wSNn1DEeCF8NjrBemJWQ_469587146" />
  <messageBuildingBlock
    xmi:id="_DLRuJwvfEeK9Xewg3qiFQA"
    nextVersions="_9sSXtTV9EeODSIIQsYYKhw"
    name="StatusReport"
    definition="Status of the point of interaction (POI), its components and their installed versions."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="StsRpt"
    complexType="_dTvNEQyVEeK5P9Ihqok3VA" />
  <messageBuildingBlock
    xmi:id="_DLRuKwvfEeK9Xewg3qiFQA"
    nextVersions="_9sSXtzV9EeODSIIQsYYKhw"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_lLfC8QvFEeKzJ69IWwzB9Q" />
  <messageDefinitionIdentifier
    businessArea="catm"
    messageFunctionality="001"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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