StatusReportV09

catm.001.001.09

The StatusReport message is sent by a POI to inform 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
%% StatusReportV09 recursion level 0 with max 0
StatusReportV09 *-- "1..1" TMSHeader1 : Header
StatusReportV09 *-- "1..1" StatusReport9 : StatusReport
StatusReportV09 *-- "0..1" ContentInformationType21 : 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
%% TMSHeader1 recursion level 0 with max 1
class TMSHeader1{
    DownloadTransfer IsoTrueFalseIndicator
    FormatVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    CreationDateTime IsoISODateTime
}
TMSHeader1 *-- "1..1" GenericIdentification176 : InitiatingParty
TMSHeader1 *-- "0..1" GenericIdentification177 : RecipientParty
TMSHeader1 *-- "0..0" Traceability8 : Traceability
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification177 recursion level 1 with max 1
class GenericIdentification177{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
GenericIdentification177 *-- "0..1" NetworkParameters7 : RemoteAccess
GenericIdentification177 *-- "0..1" Geolocation1 : Geolocation
%% Traceability8 recursion level 1 with max 1
class Traceability8{
    ProtocolName IsoMax35Text
    ProtocolVersion IsoMax6Text
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability8 *-- "1..1" GenericIdentification177 : RelayIdentification

TMSHeader1 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.	IsoNumber - 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.	GenericIdentification176 - Required 1..1
RecipientParty	Unique identification of the partner that is the recipient of the exchange.	GenericIdentification177 - Optional 0..1
Traceability	Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges.	Traceability8 - Unknown 0..0

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 (Point Of Interaction), its components and their installed versions. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% StatusReport9 recursion level 0 with max 1
StatusReport9 *-- "1..1" GenericIdentification176 : POIIdentification
StatusReport9 *-- "0..1" TriggerInformation2 : InitiatingTrigger
StatusReport9 *-- "1..1" GenericIdentification176 : TerminalManagerIdentification
StatusReport9 *-- "1..1" StatusReportDataSetRequest1 : DataSet
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% TriggerInformation2 recursion level 1 with max 1
class TriggerInformation2{
    TriggerSource PartyType5Code
    SourceIdentification IsoMax35Text
    TriggerType ExchangePolicy2Code
    AdditionalInformation IsoMax70Text
}
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% StatusReportDataSetRequest1 recursion level 1 with max 1
class StatusReportDataSetRequest1{
    SequenceCounter IsoMax9NumericText
}
StatusReportDataSetRequest1 *-- "1..1" DataSetIdentification8 : Identification
StatusReportDataSetRequest1 *-- "1..1" StatusReportContent9 : Content

StatusReport9 members

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

SecurityTrailer building block

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

classDiagram
   direction tb
%% ContentInformationType21 recursion level 0 with max 1
class ContentInformationType21{
    ContentType ContentType2Code
}
ContentInformationType21 *-- "0..1" AuthenticatedData6 : AuthenticatedData
ContentInformationType21 *-- "0..1" SignedData5 : SignedData
%% AuthenticatedData6 recursion level 1 with max 1
class AuthenticatedData6{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData6 *-- "1..0" IRecipient8Choice : Recipient
AuthenticatedData6 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData6 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
%% SignedData5 recursion level 1 with max 1
class SignedData5{
    Version IsoNumber
    Certificate IsoMax5000Binary
}
SignedData5 *-- "0..0" AlgorithmIdentification21 : DigestAlgorithm
SignedData5 *-- "0..1" EncapsulatedContent3 : EncapsulatedContent
SignedData5 *-- "0..0" Signer4 : Signer

ContentInformationType21 members

Member name	Description	Data Type / Multiplicity
ContentType	Type of data protection.	ContentType2Code - Required 1..1
AuthenticatedData	Data protection by a message authentication code (MAC).	AuthenticatedData6 - Optional 0..1
SignedData	Data protected by a digital signatures.	SignedData5 - Optional 0..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    StatusReportV09 --|> IOuterRecord : Implements
    StatusReportV09Document --|> IOuterDocument~StatusReportV09~ : Implements
    class IOuterDocument~StatusReportV09~ {
        StatusReportV09 Message
     }

Document wrapper for serialization

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

classDiagram
    StatusReportV09Document *-- StatusReportV09 : 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.09">
    <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="_PQf58RBcEeqgJK7e3n_EXA"
  nextVersions="_eFphASi2Eeurkfo6MpvKDA"
  previousVersion="_3YeBcfGQEeibbsF9Yi4diw"
  name="StatusReportV09"
  definition="The StatusReport message is sent by a POI to inform 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">
  <doclet
    xmi:id="_PQf58xBcEeqgJK7e3n_EXA"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_PQf59RBcEeqgJK7e3n_EXA"
    nextVersions="_eFqIEyi2Eeurkfo6MpvKDA"
    previousVersion="_3YeBdfGQEeibbsF9Yi4diw"
    name="Header"
    definition="Set of characteristics related to the transfer of the status report."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_ROuPdwuhEeqw5uEXxQ9H4g" />
  <messageBuildingBlock
    xmi:id="_PQf59xBcEeqgJK7e3n_EXA"
    nextVersions="_eFqIFSi2Eeurkfo6MpvKDA"
    previousVersion="_3YeBd_GQEeibbsF9Yi4diw"
    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="_8cfBURBbEeqgJK7e3n_EXA" />
  <messageBuildingBlock
    xmi:id="_PQf5-RBcEeqgJK7e3n_EXA"
    nextVersions="_eFqIFyi2Eeurkfo6MpvKDA"
    previousVersion="_3YeBefGQEeibbsF9Yi4diw"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_gkSEMQuhEeqw5uEXxQ9H4g" />
  <messageDefinitionIdentifier
    businessArea="catm"
    messageFunctionality="001"
    flavour="001"
    version="09" />
</messageDefinition>

ISO Building Blocks

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