StatusReportV03

catm.001.001.03

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
%% StatusReportV03 recursion level 0 with max 0
StatusReportV03 *-- "1..1" Header4 : Header
StatusReportV03 *-- "1..1" StatusReport3 : StatusReport
StatusReportV03 *-- "1..1" ContentInformationType9 : 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 (Point Of Interaction), its components and their installed versions. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% StatusReport3 recursion level 0 with max 1
StatusReport3 *-- "1..1" GenericIdentification35 : POIIdentification
StatusReport3 *-- "0..1" GenericIdentification35 : TerminalManagerIdentification
StatusReport3 *-- "1..0" TerminalManagementDataSet9 : 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
}
%% TerminalManagementDataSet9 recursion level 1 with max 1
class TerminalManagementDataSet9{
    SequenceCounter IsoMax9NumericText
}
TerminalManagementDataSet9 *-- "1..1" DataSetIdentification3 : Identification
TerminalManagementDataSet9 *-- "1..1" StatusReportContent3 : Content
  

StatusReport3 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
%% ContentInformationType9 recursion level 0 with max 1
class ContentInformationType9{
    ContentType ContentType1Code
}
ContentInformationType9 *-- "0..1" EnvelopedData3 : EnvelopedData
ContentInformationType9 *-- "0..1" AuthenticatedData3 : AuthenticatedData
ContentInformationType9 *-- "0..1" SignedData3 : SignedData
ContentInformationType9 *-- "0..1" DigestedData3 : DigestedData
%% EnvelopedData3 recursion level 1 with max 1
class EnvelopedData3{
    Version IsoNumber
}
EnvelopedData3 *-- "1..0" IRecipient3Choice : Recipient
EnvelopedData3 *-- "1..1" EncryptedContent2 : EncryptedContent
%% AuthenticatedData3 recursion level 1 with max 1
class AuthenticatedData3{
    Version IsoNumber
    MAC IsoMax35Binary
}
AuthenticatedData3 *-- "1..0" IRecipient3Choice : Recipient
AuthenticatedData3 *-- "1..1" AlgorithmIdentification10 : MACAlgorithm
AuthenticatedData3 *-- "1..1" EncapsulatedContent2 : EncapsulatedContent
%% SignedData3 recursion level 1 with max 1
class SignedData3{
    Version IsoNumber
    Certificate IsoMax3000Binary
}
SignedData3 *-- "1..0" AlgorithmIdentification5 : DigestAlgorithm
SignedData3 *-- "1..1" EncapsulatedContent2 : EncapsulatedContent
SignedData3 *-- "1..0" Signer2 : Signer
%% DigestedData3 recursion level 1 with max 1
class DigestedData3{
    Version IsoNumber
    Digest IsoMax140Text
}
DigestedData3 *-- "1..0" AlgorithmIdentification5 : DigestAlgorithm
DigestedData3 *-- "1..1" EncapsulatedContent2 : EncapsulatedContent
  

ContentInformationType9 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    StatusReportV03 --|> IOuterRecord : Implements
    StatusReportV03Document --|> IOuterDocument~StatusReportV03~ : Implements
    class IOuterDocument~StatusReportV03~ {
        StatusReportV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    StatusReportV03Document *-- StatusReportV03 : 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.03">
    <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="_9sSXsTV9EeODSIIQsYYKhw"
  nextVersions="_aFhi0WpIEeSxBNa3WmxpmQ"
  previousVersion="_DLRuIQvfEeK9Xewg3qiFQA"
  name="StatusReportV03"
  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="_91zgEDV9EeODSIIQsYYKhw"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_9sSXszV9EeODSIIQsYYKhw"
    nextVersions="_aFhi1WpIEeSxBNa3WmxpmQ"
    previousVersion="_DLRuIwvfEeK9Xewg3qiFQA"
    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="_9sSXtTV9EeODSIIQsYYKhw"
    nextVersions="_aFhi12pIEeSxBNa3WmxpmQ"
    previousVersion="_DLRuJwvfEeK9Xewg3qiFQA"
    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="_J4TeETV9EeODSIIQsYYKhw" />
  <messageBuildingBlock
    xmi:id="_9sSXtzV9EeODSIIQsYYKhw"
    nextVersions="_aFhi2WpIEeSxBNa3WmxpmQ"
    previousVersion="_DLRuKwvfEeK9Xewg3qiFQA"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_ZSh2oTScEeOnFuyVSIQZKg" />
  <messageDefinitionIdentifier
    businessArea="catm"
    messageFunctionality="001"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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