StatusReportV08

catm.001.001.08

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
%% StatusReportV08 recursion level 0 with max 0
StatusReportV08 *-- "1..1" Header27 : Header
StatusReportV08 *-- "1..1" StatusReport8 : StatusReport
StatusReportV08 *-- "0..1" ContentInformationType18 : 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
%% Header27 recursion level 0 with max 1
class Header27{
    DownloadTransfer IsoTrueFalseIndicator
    FormatVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    CreationDateTime IsoISODateTime
}
Header27 *-- "1..1" GenericIdentification71 : InitiatingParty
Header27 *-- "0..1" GenericIdentification92 : RecipientParty
%% GenericIdentification71 recursion level 1 with max 1
class GenericIdentification71{
    Identification IsoMax35Text
    Type PartyType5Code
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification92 recursion level 1 with max 1
class GenericIdentification92{
    Identification IsoMax35Text
    Type PartyType5Code
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
GenericIdentification92 *-- "0..1" NetworkParameters5 : RemoteAccess
  

Header27 members

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
%% StatusReport8 recursion level 0 with max 1
StatusReport8 *-- "1..1" GenericIdentification71 : POIIdentification
StatusReport8 *-- "0..1" TriggerInformation1 : InitiatingTrigger
StatusReport8 *-- "1..1" GenericIdentification71 : TerminalManagerIdentification
StatusReport8 *-- "1..1" TerminalManagementDataSet28 : DataSet
%% GenericIdentification71 recursion level 1 with max 1
class GenericIdentification71{
    Identification IsoMax35Text
    Type PartyType5Code
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% TriggerInformation1 recursion level 1 with max 1
class TriggerInformation1{
    TriggerSource PartyType5Code
    SourceIdentification IsoMax35Text
    TriggerType ExchangePolicy1Code
    AdditionalInformation IsoMax70Text
}
%% GenericIdentification71 recursion level 1 with max 1
class GenericIdentification71{
    Identification IsoMax35Text
    Type PartyType5Code
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% TerminalManagementDataSet28 recursion level 1 with max 1
class TerminalManagementDataSet28{
    SequenceCounter IsoMax9NumericText
}
TerminalManagementDataSet28 *-- "1..1" DataSetIdentification7 : Identification
TerminalManagementDataSet28 *-- "1..1" StatusReportContent8 : Content
  

StatusReport8 members

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
%% ContentInformationType18 recursion level 0 with max 1
class ContentInformationType18{
    ContentType ContentType2Code
}
ContentInformationType18 *-- "0..1" AuthenticatedData5 : AuthenticatedData
ContentInformationType18 *-- "0..1" SignedData5 : SignedData
%% AuthenticatedData5 recursion level 1 with max 1
class AuthenticatedData5{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData5 *-- "1..0" IRecipient6Choice : Recipient
AuthenticatedData5 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData5 *-- "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
  

ContentInformationType18 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    StatusReportV08 --|> IOuterRecord : Implements
    StatusReportV08Document --|> IOuterDocument~StatusReportV08~ : Implements
    class IOuterDocument~StatusReportV08~ {
        StatusReportV08 Message
     }
  

Document wrapper for serialization

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

classDiagram
    StatusReportV08Document *-- StatusReportV08 : 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.08">
    <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="_3YeBcfGQEeibbsF9Yi4diw"
  nextVersions="_PQf58RBcEeqgJK7e3n_EXA"
  previousVersion="_VHEoUdqPEeearpaEPXv9UA"
  name="StatusReportV08"
  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">
  <doclet
    xmi:id="_3YeBc_GQEeibbsF9Yi4diw"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_3YeBdfGQEeibbsF9Yi4diw"
    nextVersions="_PQf59RBcEeqgJK7e3n_EXA"
    previousVersion="_VHEoVdqPEeearpaEPXv9UA"
    name="Header"
    definition="Set of characteristics related to the transfer of the status report."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_4lU_YY3bEeW32YMP0mBeyw" />
  <messageBuildingBlock
    xmi:id="_3YeBd_GQEeibbsF9Yi4diw"
    nextVersions="_PQf59xBcEeqgJK7e3n_EXA"
    previousVersion="_VHEoV9qPEeearpaEPXv9UA"
    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="_79V60fGQEeibbsF9Yi4diw" />
  <messageBuildingBlock
    xmi:id="_3YeBefGQEeibbsF9Yi4diw"
    nextVersions="_PQf5-RBcEeqgJK7e3n_EXA"
    previousVersion="_VHEoWdqPEeearpaEPXv9UA"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="__DJZ4dtZEee9e6xduATmQg" />
  <messageDefinitionIdentifier
    businessArea="catm"
    messageFunctionality="001"
    flavour="001"
    version="08" />
</messageDefinition>

ISO Building Blocks

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