catm.003.001.09
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
%% AcceptorConfigurationUpdateV09 recursion level 0 with max 0
AcceptorConfigurationUpdateV09 *-- "1..1" TMSHeader1 : Header
AcceptorConfigurationUpdateV09 *-- "1..1" AcceptorConfiguration9 : AcceptorConfiguration
AcceptorConfigurationUpdateV09 *-- "0..1" ContentInformationType21 : 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
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| DownloadTransfer | Indicates if the file transfer is a download or an upload. | IsoTrueFalseIndicator - Required 1..1 |
| FormatVersion | Version of file format. | IsoMax6Text - Required 1..1 |
| ExchangeIdentification | Unique identification of an exchange occurrence. | IsoNumber - Required 1..1 |
| CreationDateTime | Date and time at which the file or message was created. | IsoISODateTime - Required 1..1 |
| InitiatingParty | Unique identification of the partner that has initiated the exchange. | GenericIdentification176 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the exchange. | GenericIdentification177 - Optional 0..1 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability8 - Unknown 0..0 |
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
%% AcceptorConfiguration9 recursion level 0 with max 1
AcceptorConfiguration9 *-- "1..1" GenericIdentification176 : TerminalManagerIdentification
AcceptorConfiguration9 *-- "1..0" AcceptorConfigurationDataSet1 : DataSet
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
Identification IsoMax35Text
Type PartyType33Code
Issuer PartyType33Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% AcceptorConfigurationDataSet1 recursion level 1 with max 1
class AcceptorConfigurationDataSet1{
SequenceCounter IsoMax9NumericText
ConfigurationScope PartyType15Code
}
AcceptorConfigurationDataSet1 *-- "1..1" DataSetIdentification8 : Identification
AcceptorConfigurationDataSet1 *-- "0..0" GenericIdentification176 : POIIdentification
AcceptorConfigurationDataSet1 *-- "1..1" AcceptorConfigurationContent9 : Content
AcceptorConfiguration9 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| TerminalManagerIdentification | Identification of the terminal management system (TMS) sending the acceptor parameters. | GenericIdentification176 - Required 1..1 |
| DataSet | Data set containing the acceptor parameters of a point of interaction (POI). | AcceptorConfigurationDataSet1 - Unknown 1..0 |
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
%% ContentInformationType21 recursion level 0 with max 1
class ContentInformationType21{
ContentType ContentType2Code
}
ContentInformationType21 *-- "0..1" AuthenticatedData6 : AuthenticatedData
ContentInformationType21 *-- "0..1" SignedData5 : SignedData
%% AuthenticatedData6 recursion level 1 with max 1
class AuthenticatedData6{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData6 *-- "1..0" IRecipient8Choice : Recipient
AuthenticatedData6 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData6 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
%% SignedData5 recursion level 1 with max 1
class SignedData5{
Version IsoNumber
Certificate IsoMax5000Binary
}
SignedData5 *-- "0..0" AlgorithmIdentification21 : DigestAlgorithm
SignedData5 *-- "0..1" EncapsulatedContent3 : EncapsulatedContent
SignedData5 *-- "0..0" Signer4 : Signer
ContentInformationType21 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ContentType | Type of data protection. | ContentType2Code - Required 1..1 |
| AuthenticatedData | Data protection by a message authentication code (MAC). | AuthenticatedData6 - Optional 0..1 |
| SignedData | Data protected by a digital signatures. | SignedData5 - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorConfigurationUpdateV09 implementation follows a specific implementaiton pattern. First of all, AcceptorConfigurationUpdateV09 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorConfigurationUpdateV09Document implements IOuterDocument. Because AcceptorConfigurationUpdateV09 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorConfigurationUpdateV09.
classDiagram
class IOuterRecord
AcceptorConfigurationUpdateV09 --|> IOuterRecord : Implements
AcceptorConfigurationUpdateV09Document --|> IOuterDocument~AcceptorConfigurationUpdateV09~ : Implements
class IOuterDocument~AcceptorConfigurationUpdateV09~ {
AcceptorConfigurationUpdateV09 Message
}
Document wrapper for serialization
The only real purpose AcceptorConfigurationUpdateV09Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:catm.003.001.09’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorConfigurationUpdateV09.ToDocument() method. The returned AcceptorConfigurationUpdateV09Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorConfigurationUpdateV09Document *-- AcceptorConfigurationUpdateV09 : 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.09">
<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="_EBcV0QuhEeqw5uEXxQ9H4g"
nextVersions="_6QnekS1vEeuZtpnZJ4v-5Q"
previousVersion="_yuPRkdXyEeia9rtBTv_9KA"
name="AcceptorConfigurationUpdateV09"
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="_EBc84QuhEeqw5uEXxQ9H4g"
type="purpose" />
<messageBuildingBlock
xmi:id="_EBc84wuhEeqw5uEXxQ9H4g"
nextVersions="_6QnelS1vEeuZtpnZJ4v-5Q"
previousVersion="_yuQfsdXyEeia9rtBTv_9KA"
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="_EBc85QuhEeqw5uEXxQ9H4g"
nextVersions="_6Qnely1vEeuZtpnZJ4v-5Q"
previousVersion="_yuQfs9XyEeia9rtBTv_9KA"
name="AcceptorConfiguration"
definition="Acceptor configuration to be downloaded from the terminal management system."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="AccptrCfgtn"
complexType="_c-QgEQueEeqw5uEXxQ9H4g" />
<messageBuildingBlock
xmi:id="_EBc85wuhEeqw5uEXxQ9H4g"
nextVersions="_6QnemS1vEeuZtpnZJ4v-5Q"
previousVersion="_yuQftdXyEeia9rtBTv_9KA"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC or a digital signature."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_gkSEMQuhEeqw5uEXxQ9H4g" />
<messageDefinitionIdentifier
businessArea="catm"
messageFunctionality="003"
flavour="001"
version="09" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.