AcceptorConfigurationUpdateV03

catm.003.001.03

Update of the acceptor configuration to be dowloaded by the terminal management system.

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
%% AcceptorConfigurationUpdateV03 recursion level 0 with max 0
AcceptorConfigurationUpdateV03 *-- "1..1" Header4 : Header
AcceptorConfigurationUpdateV03 *-- "1..1" AcceptorConfiguration3 : AcceptorConfiguration
AcceptorConfigurationUpdateV03 *-- "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 acceptor parameters. 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

AcceptorConfiguration building block

Acceptor configuration to be downloaded from the terminal management system. Acceptor configuration to be downloaded from the terminal management system. For comparison, see the ISO20022 official specification

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

AcceptorConfiguration3 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 AcceptorConfigurationUpdateV03 implementation follows a specific implementaiton pattern. First of all, AcceptorConfigurationUpdateV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorConfigurationUpdateV03Document implements IOuterDocument. Because AcceptorConfigurationUpdateV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorConfigurationUpdateV03.

classDiagram
    class IOuterRecord
    AcceptorConfigurationUpdateV03 --|> IOuterRecord : Implements
    AcceptorConfigurationUpdateV03Document --|> IOuterDocument~AcceptorConfigurationUpdateV03~ : Implements
    class IOuterDocument~AcceptorConfigurationUpdateV03~ {
        AcceptorConfigurationUpdateV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AcceptorConfigurationUpdateV03Document *-- AcceptorConfigurationUpdateV03 : 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.003.001.03">
    <AccptrCfgtnUpd>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <AccptrCfgtn>
            <!-- AcceptorConfiguration inner content -->
        </AccptrCfgtn>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </AccptrCfgtnUpd>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_TsQpkTZ8EeOP_KvUKe29ng"
  nextVersions="_fjjzoWpaEeS4r8z7dKyh1g"
  previousVersion="_ZKhMoQvfEeK9Xewg3qiFQA"
  name="AcceptorConfigurationUpdateV03"
  definition="Update of the acceptor configuration to be dowloaded by the terminal management system."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AccptrCfgtnUpd"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_T5FkoDZ8EeOP_KvUKe29ng"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_TsQpkzZ8EeOP_KvUKe29ng"
    nextVersions="_fjjzpWpaEeS4r8z7dKyh1g"
    previousVersion="_ZKhMowvfEeK9Xewg3qiFQA"
    name="Header"
    definition="Set of characteristics related to the transfer of the acceptor parameters."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_K8wSNn1DEeCF8NjrBemJWQ_469587146" />
  <messageBuildingBlock
    xmi:id="_TsQplTZ8EeOP_KvUKe29ng"
    nextVersions="_fjjzp2paEeS4r8z7dKyh1g"
    previousVersion="_ZKhMpwvfEeK9Xewg3qiFQA"
    name="AcceptorConfiguration"
    definition="Acceptor configuration to be downloaded from the terminal management system."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="AccptrCfgtn"
    complexType="_5vqksTZ7EeOP_KvUKe29ng" />
  <messageBuildingBlock
    xmi:id="_TsQplzZ8EeOP_KvUKe29ng"
    nextVersions="_fjjzqWpaEeS4r8z7dKyh1g"
    previousVersion="_ZKhMqwvfEeK9Xewg3qiFQA"
    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="003"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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