AcceptorConfigurationUpdateV01

catm.003.001.01

Scope The AcceptorConfigurationUpdate message is sent by the master terminal manager or delegated terminal manager to the acceptor system for the update of acquirer parameters, merchant parameters, vendor parameters or cryptographic keys of the acquirer. Usage The AcceptorConfigurationUpdate message may embed the information required by the acceptor system for the configuration of:

• the application parameters necessary for software applications processed by the POI system,
• the acquirer protocol parameters for the message content and message exchange behaviour of the acquirer protocol supported by the POI system,
• the host communication parameters to define the addresses of the connected acquirer hosts, and
• the merchant parameters needed for the retailer protocol settings of the POI 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
%% AcceptorConfigurationUpdateV01 recursion level 0 with max 0
AcceptorConfigurationUpdateV01 *-- "1..1" Header4 : Header
AcceptorConfigurationUpdateV01 *-- "1..1" AcceptorConfiguration1 : AcceptorConfiguration
AcceptorConfigurationUpdateV01 *-- "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 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
%% AcceptorConfiguration1 recursion level 0 with max 1
AcceptorConfiguration1 *-- "0..1" GenericIdentification35 : POIIdentification
AcceptorConfiguration1 *-- "1..1" GenericIdentification35 : TerminalManagerIdentification
AcceptorConfiguration1 *-- "1..0" TerminalManagementDataSet3 : 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
}
%% TerminalManagementDataSet3 recursion level 1 with max 1
class TerminalManagementDataSet3{
    SequenceCounter IsoMax9NumericText
}
TerminalManagementDataSet3 *-- "1..1" DataSetIdentification2 : Identification
TerminalManagementDataSet3 *-- "1..1" AcceptorConfigurationContent1 : Content
  

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

classDiagram
    class IOuterRecord
    AcceptorConfigurationUpdateV01 --|> IOuterRecord : Implements
    AcceptorConfigurationUpdateV01Document --|> IOuterDocument~AcceptorConfigurationUpdateV01~ : Implements
    class IOuterDocument~AcceptorConfigurationUpdateV01~ {
        AcceptorConfigurationUpdateV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AcceptorConfigurationUpdateV01Document *-- AcceptorConfigurationUpdateV01 : 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.01">
    <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="_AgFfYOQXEeCGktPI9k4Dlw_1733626146"
  nextVersions="_ZKhMoQvfEeK9Xewg3qiFQA"
  name="AcceptorConfigurationUpdateV01"
  definition="Scope&#xD;&#xA;The AcceptorConfigurationUpdate message is sent by the master terminal manager or delegated terminal manager to the acceptor system for the update of acquirer parameters, merchant parameters, vendor parameters or cryptographic keys of the acquirer.&#xD;&#xA;Usage&#xD;&#xA;The AcceptorConfigurationUpdate message may embed the information required by the acceptor system for the configuration of:&#xD;&#xA;- the application parameters necessary for software applications processed by the POI system,&#xD;&#xA;- the acquirer protocol parameters for the message content and message exchange behaviour of the acquirer protocol supported by the POI system,&#xD;&#xA;- the host communication parameters to define the addresses of the connected acquirer hosts, and&#xD;&#xA;- the merchant parameters needed for the retailer protocol settings of the POI system."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AccptrCfgtnUpd"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_AgFfYeQXEeCGktPI9k4Dlw_-1237434314"
    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="_AgFfYuQXEeCGktPI9k4Dlw_950623241"
    name="AcceptorConfiguration"
    definition="Acceptor configuration to be downloaded from the terminal management system."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="AccptrCfgtn"
    complexType="_LYek5H1DEeCF8NjrBemJWQ_-1760304679" />
  <messageBuildingBlock
    xmi:id="_AgFfY-QXEeCGktPI9k4Dlw_543485283"
    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="003"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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