StatusReportV01

catm.001.001.01

Scope The StatusReport message is sent by the card acceptor to the master terminal manager or delegated terminal manager to inform these entities about the status of the acceptor system. Usage The StatusReport message may embed the information required by the master terminal manager or delegated terminal manager for preparing the needed TMS actions in the management plan to be replaced and the acceptor parameters to be updated.

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
%% StatusReportV01 recursion level 0 with max 0
StatusReportV01 *-- "1..1" Header4 : Header
StatusReportV01 *-- "1..1" StatusReport1 : StatusReport
StatusReportV01 *-- "1..1" ContentInformationType1 : 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

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
%% StatusReport1 recursion level 0 with max 1
StatusReport1 *-- "1..1" GenericIdentification35 : POIIdentification
StatusReport1 *-- "0..1" GenericIdentification35 : TerminalManagerIdentification
StatusReport1 *-- "1..0" TerminalManagementDataSet1 : 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
}
%% TerminalManagementDataSet1 recursion level 1 with max 1
class TerminalManagementDataSet1{
    SequenceCounter IsoMax9NumericText
}
TerminalManagementDataSet1 *-- "1..1" DataSetIdentification2 : Identification
TerminalManagementDataSet1 *-- "1..1" StatusReportContent1 : Content
  

StatusReport1 members

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
%% ContentInformationType1 recursion level 0 with max 1
class ContentInformationType1{
    ContentType ContentType1Code
}
ContentInformationType1 *-- "0..1" EnvelopedData1 : EnvelopedData
ContentInformationType1 *-- "0..1" AuthenticatedData1 : AuthenticatedData
ContentInformationType1 *-- "0..1" SignedData1 : SignedData
ContentInformationType1 *-- "0..1" DigestedData1 : DigestedData
ContentInformationType1 *-- "0..1" NamedKeyEncryptedData1 : NamedKeyEncryptedData
%% EnvelopedData1 recursion level 1 with max 1
class EnvelopedData1{
    Version IsoNumber
}
EnvelopedData1 *-- "1..0" IRecipient1Choice : Recipient
EnvelopedData1 *-- "1..1" EncryptedContent1 : EncryptedContent
%% AuthenticatedData1 recursion level 1 with max 1
class AuthenticatedData1{
    Version IsoNumber
    MAC IsoMax35Binary
}
AuthenticatedData1 *-- "1..0" IRecipient1Choice : Recipient
AuthenticatedData1 *-- "1..1" AlgorithmIdentification1 : MACAlgorithm
AuthenticatedData1 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
%% SignedData1 recursion level 1 with max 1
class SignedData1{
    Version IsoNumber
    Certificate IsoMax3000Binary
}
SignedData1 *-- "1..0" AlgorithmIdentification1 : DigestAlgorithm
SignedData1 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
SignedData1 *-- "1..0" Signer1 : Signer
%% DigestedData1 recursion level 1 with max 1
class DigestedData1{
    Version IsoNumber
    Digest IsoMax140Text
}
DigestedData1 *-- "1..0" AlgorithmIdentification1 : DigestAlgorithm
DigestedData1 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
%% NamedKeyEncryptedData1 recursion level 1 with max 1
class NamedKeyEncryptedData1{
    Version IsoNumber
    KeyName IsoMax140Text
}
NamedKeyEncryptedData1 *-- "1..1" EncryptedContent1 : EncryptedContent
  

ContentInformationType1 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    StatusReportV01 --|> IOuterRecord : Implements
    StatusReportV01Document --|> IOuterDocument~StatusReportV01~ : Implements
    class IOuterDocument~StatusReportV01~ {
        StatusReportV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    StatusReportV01Document *-- StatusReportV01 : 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.01">
    <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="_8ki24OQWEeCGktPI9k4Dlw_716782601"
  nextVersions="_DLRuIQvfEeK9Xewg3qiFQA"
  name="StatusReportV01"
  definition="Scope&#xD;&#xA;The StatusReport message is sent by the card acceptor to the master terminal manager or delegated terminal manager to inform these entities about the status of the acceptor system.&#xD;&#xA;Usage&#xD;&#xA;The StatusReport message may embed the information required by the master terminal manager or delegated terminal manager for preparing the needed TMS actions in the management plan to be replaced and the acceptor parameters to be updated."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="StsRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_8ki24eQWEeCGktPI9k4Dlw_817647362"
    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="_8ki24uQWEeCGktPI9k4Dlw_2054938442"
    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="_LYnu2H1DEeCF8NjrBemJWQ_885541956" />
  <messageBuildingBlock
    xmi:id="_8ki24-QWEeCGktPI9k4Dlw_1773797778"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_SwFm2gEcEeCQm6a_G2yO_w_1341928510" />
  <messageDefinitionIdentifier
    businessArea="catm"
    messageFunctionality="001"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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