AcceptorConfigurationUpdateV10

catm.003.001.10

The AcceptorConfigurationUpdate message is sent by a TM to a POI to update configurations.

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
%% AcceptorConfigurationUpdateV10 recursion level 0 with max 0
AcceptorConfigurationUpdateV10 *-- "1..1" TMSHeader1 : Header
AcceptorConfigurationUpdateV10 *-- "1..1" AcceptorConfiguration10 : AcceptorConfiguration
AcceptorConfigurationUpdateV10 *-- "0..1" ContentInformationType25 : 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
%% 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

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
%% AcceptorConfiguration10 recursion level 0 with max 1
class AcceptorConfiguration10{
    POIGroupIdentification IsoMax35Text
}
AcceptorConfiguration10 *-- "1..1" GenericIdentification176 : TerminalManagerIdentification
AcceptorConfiguration10 *-- "1..0" AcceptorConfigurationDataSet2 : DataSet
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% AcceptorConfigurationDataSet2 recursion level 1 with max 1
class AcceptorConfigurationDataSet2{
    SequenceCounter IsoMax9NumericText
    LastSequence IsoTrueFalseIndicator
    ConfigurationScope PartyType15Code
}
AcceptorConfigurationDataSet2 *-- "1..1" DataSetIdentification8 : Identification
AcceptorConfigurationDataSet2 *-- "0..0" GenericIdentification176 : POIIdentification
AcceptorConfigurationDataSet2 *-- "1..1" AcceptorConfigurationContent10 : Content
  

AcceptorConfiguration10 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
%% ContentInformationType25 recursion level 0 with max 1
class ContentInformationType25{
    ContentType ContentType2Code
}
ContentInformationType25 *-- "0..1" AuthenticatedData7 : AuthenticatedData
ContentInformationType25 *-- "0..1" SignedData6 : SignedData
%% AuthenticatedData7 recursion level 1 with max 1
class AuthenticatedData7{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData7 *-- "1..0" IRecipient10Choice : Recipient
AuthenticatedData7 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData7 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
%% SignedData6 recursion level 1 with max 1
class SignedData6{
    Version IsoNumber
    Certificate IsoMax5000Binary
}
SignedData6 *-- "0..0" AlgorithmIdentification21 : DigestAlgorithm
SignedData6 *-- "0..1" EncapsulatedContent3 : EncapsulatedContent
SignedData6 *-- "0..0" Signer5 : Signer
  

ContentInformationType25 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorConfigurationUpdateV10 --|> IOuterRecord : Implements
    AcceptorConfigurationUpdateV10Document --|> IOuterDocument~AcceptorConfigurationUpdateV10~ : Implements
    class IOuterDocument~AcceptorConfigurationUpdateV10~ {
        AcceptorConfigurationUpdateV10 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AcceptorConfigurationUpdateV10Document *-- AcceptorConfigurationUpdateV10 : 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.10">
    <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="_6QnekS1vEeuZtpnZJ4v-5Q"
  nextVersions="_mjCuwVEJEeyApZmLzm74zA"
  previousVersion="_EBcV0QuhEeqw5uEXxQ9H4g"
  name="AcceptorConfigurationUpdateV10"
  definition="The AcceptorConfigurationUpdate message is sent by a TM to a POI to update configurations."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AccptrCfgtnUpd"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_6Qneky1vEeuZtpnZJ4v-5Q"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_6QnelS1vEeuZtpnZJ4v-5Q"
    nextVersions="_mjCuxVEJEeyApZmLzm74zA"
    previousVersion="_EBc84wuhEeqw5uEXxQ9H4g"
    name="Header"
    definition="Set of characteristics related to the transfer of the acceptor parameters."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_ROuPdwuhEeqw5uEXxQ9H4g" />
  <messageBuildingBlock
    xmi:id="_6Qnely1vEeuZtpnZJ4v-5Q"
    nextVersions="_mjCux1EJEeyApZmLzm74zA"
    previousVersion="_EBc85QuhEeqw5uEXxQ9H4g"
    name="AcceptorConfiguration"
    definition="Acceptor configuration to be downloaded from the terminal management system."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="AccptrCfgtn"
    complexType="_t9Kv8S1vEeuZtpnZJ4v-5Q" />
  <messageBuildingBlock
    xmi:id="_6QnemS1vEeuZtpnZJ4v-5Q"
    nextVersions="_mjCuyVEJEeyApZmLzm74zA"
    previousVersion="_EBc85wuhEeqw5uEXxQ9H4g"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_kWoPYS8jEeu125Ip9zFcsQ" />
  <messageDefinitionIdentifier
    businessArea="catm"
    messageFunctionality="003"
    flavour="001"
    version="10" />
</messageDefinition>

ISO Building Blocks

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