Iso20022

StatusReportV12

catm.001.001.12

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
%% StatusReportV12 recursion level 0 with max 0
StatusReportV12 *-- "1..1" TMSHeader1 : Header
StatusReportV12 *-- "1..1" StatusReport12 : StatusReport
StatusReportV12 *-- "0..1" ContentInformationType33 : 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
%% StatusReport12 recursion level 0 with max 1
StatusReport12 *-- "1..1" GenericIdentification176 : POIIdentification
StatusReport12 *-- "0..1" TriggerInformation2 : InitiatingTrigger
StatusReport12 *-- "1..1" GenericIdentification176 : TerminalManagerIdentification
StatusReport12 *-- "1..1" StatusReportDataSetRequest4 : 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
}
%% StatusReportDataSetRequest4 recursion level 1 with max 1
class StatusReportDataSetRequest4{
    SequenceCounter IsoMax9NumericText
    LastSequence IsoTrueFalseIndicator
}
StatusReportDataSetRequest4 *-- "1..1" DataSetIdentification10 : Identification
StatusReportDataSetRequest4 *-- "1..1" StatusReportContent12 : Content

StatusReport12 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). StatusReportDataSetRequest4 - 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
%% ContentInformationType33 recursion level 0 with max 1
class ContentInformationType33{
    ContentType ContentType2Code
}
ContentInformationType33 *-- "0..1" AuthenticatedData9 : AuthenticatedData
ContentInformationType33 *-- "0..1" SignedData8 : SignedData
%% AuthenticatedData9 recursion level 1 with max 1
class AuthenticatedData9{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData9 *-- "1..0" IRecipient14Choice : Recipient
AuthenticatedData9 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData9 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
%% SignedData8 recursion level 1 with max 1
class SignedData8{
    Version IsoNumber
    Certificate IsoMax5000Binary
}
SignedData8 *-- "0..0" AlgorithmIdentification21 : DigestAlgorithm
SignedData8 *-- "0..1" EncapsulatedContent3 : EncapsulatedContent
SignedData8 *-- "0..0" Signer7 : Signer

ContentInformationType33 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). AuthenticatedData9 - Optional 0..1
SignedData Data protected by a digital signatures. SignedData8 - Optional 0..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    StatusReportV12 --|> IOuterRecord : Implements
    StatusReportV12Document --|> IOuterDocument~StatusReportV12~ : Implements
    class IOuterDocument~StatusReportV12~ {
        StatusReportV12 Message
     }

Document wrapper for serialization

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

classDiagram
    StatusReportV12Document *-- StatusReportV12 : 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.12">
    <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="_iIi6wXPPEe2pK6udhxEaHA"
  previousVersion="_I2ARkU6tEeyGi9JAv6wq7Q"
  name="StatusReportV12"
  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="_WYMCwJVPEeO6Q83g-JIX_w"
  xmlTag="StsRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_iIjh0XPPEe2pK6udhxEaHA"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_iIjh03PPEe2pK6udhxEaHA"
    previousVersion="_I2ARlU6tEeyGi9JAv6wq7Q"
    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="_iIjh1XPPEe2pK6udhxEaHA"
    previousVersion="_I2ARl06tEeyGi9JAv6wq7Q"
    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="_t7bCUXJjEe299ZbWCkdR_w" />
  <messageBuildingBlock
    xmi:id="_iIjh13PPEe2pK6udhxEaHA"
    previousVersion="_I2ARmU6tEeyGi9JAv6wq7Q"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_sqC0wXDIEe2MCaKO5AtGsA" />
  <messageDefinitionIdentifier
    businessArea="catm"
    messageFunctionality="001"
    flavour="001"
    version="12" />
</messageDefinition>

ISO Building Blocks

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