catm.003.001.12
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
%% AcceptorConfigurationUpdateV12 recursion level 0 with max 0
AcceptorConfigurationUpdateV12 *-- "1..1" TMSHeader1 : Header
AcceptorConfigurationUpdateV12 *-- "1..1" AcceptorConfiguration12 : AcceptorConfiguration
AcceptorConfigurationUpdateV12 *-- "0..1" ContentInformationType33 : 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
%% AcceptorConfiguration12 recursion level 0 with max 1
class AcceptorConfiguration12{
POIGroupIdentification IsoMax35Text
}
AcceptorConfiguration12 *-- "1..1" GenericIdentification176 : TerminalManagerIdentification
AcceptorConfiguration12 *-- "1..0" AcceptorConfigurationDataSet4 : DataSet
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
Identification IsoMax35Text
Type PartyType33Code
Issuer PartyType33Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% AcceptorConfigurationDataSet4 recursion level 1 with max 1
class AcceptorConfigurationDataSet4{
SequenceCounter IsoMax9NumericText
LastSequence IsoTrueFalseIndicator
ConfigurationScope PartyType15Code
}
AcceptorConfigurationDataSet4 *-- "1..1" DataSetIdentification10 : Identification
AcceptorConfigurationDataSet4 *-- "0..0" GenericIdentification176 : POIIdentification
AcceptorConfigurationDataSet4 *-- "1..1" AcceptorConfigurationContent12 : Content
AcceptorConfiguration12 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| TerminalManagerIdentification | Identification of the terminal management system (TMS) sending the acceptor parameters. | GenericIdentification176 - Required 1..1 |
| POIGroupIdentification | Identifier assigned to a set of POI terminals performing some categories of transactions. | IsoMax35Text - Unknown 0..0 |
| DataSet | Data set containing the acceptor parameters of a point of interaction (POI). | AcceptorConfigurationDataSet4 - 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
%% ContentInformationType33 recursion level 0 with max 1
class ContentInformationType33{
ContentType ContentType2Code
}
ContentInformationType33 *-- "0..1" AuthenticatedData9 : AuthenticatedData
ContentInformationType33 *-- "0..1" SignedData8 : SignedData
%% AuthenticatedData9 recursion level 1 with max 1
class AuthenticatedData9{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData9 *-- "1..0" IRecipient14Choice : Recipient
AuthenticatedData9 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData9 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
%% SignedData8 recursion level 1 with max 1
class SignedData8{
Version IsoNumber
Certificate IsoMax5000Binary
}
SignedData8 *-- "0..0" AlgorithmIdentification21 : DigestAlgorithm
SignedData8 *-- "0..1" EncapsulatedContent3 : EncapsulatedContent
SignedData8 *-- "0..0" Signer7 : Signer
ContentInformationType33 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). | AuthenticatedData9 - Optional 0..1 |
| SignedData | Data protected by a digital signatures. | SignedData8 - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorConfigurationUpdateV12 implementation follows a specific implementaiton pattern. First of all, AcceptorConfigurationUpdateV12 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorConfigurationUpdateV12Document implements IOuterDocument. Because AcceptorConfigurationUpdateV12 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorConfigurationUpdateV12.
classDiagram
class IOuterRecord
AcceptorConfigurationUpdateV12 --|> IOuterRecord : Implements
AcceptorConfigurationUpdateV12Document --|> IOuterDocument~AcceptorConfigurationUpdateV12~ : Implements
class IOuterDocument~AcceptorConfigurationUpdateV12~ {
AcceptorConfigurationUpdateV12 Message
}
Document wrapper for serialization
The only real purpose AcceptorConfigurationUpdateV12Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:catm.003.001.12’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorConfigurationUpdateV12.ToDocument() method. The returned AcceptorConfigurationUpdateV12Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorConfigurationUpdateV12Document *-- AcceptorConfigurationUpdateV12 : 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.12">
<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="_hasO4XPSEe2pK6udhxEaHA"
previousVersion="_mjCuwVEJEeyApZmLzm74zA"
name="AcceptorConfigurationUpdateV12"
definition="The AcceptorConfigurationUpdate message is sent by a TM to a POI to update configurations."
registrationStatus="Registered"
messageSet="_WYMCwJVPEeO6Q83g-JIX_w"
xmlTag="AccptrCfgtnUpd"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<doclet
xmi:id="_hasO43PSEe2pK6udhxEaHA"
type="purpose" />
<messageBuildingBlock
xmi:id="_hasO5XPSEe2pK6udhxEaHA"
previousVersion="_mjCuxVEJEeyApZmLzm74zA"
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="_hasO53PSEe2pK6udhxEaHA"
previousVersion="_mjCux1EJEeyApZmLzm74zA"
name="AcceptorConfiguration"
definition="Acceptor configuration to be downloaded from the terminal management system."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="AccptrCfgtn"
complexType="_PLZ6oXJ3Ee299ZbWCkdR_w" />
<messageBuildingBlock
xmi:id="_hasO6XPSEe2pK6udhxEaHA"
previousVersion="_mjCuyVEJEeyApZmLzm74zA"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC or a digital signature."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_sqC0wXDIEe2MCaKO5AtGsA" />
<messageDefinitionIdentifier
businessArea="catm"
messageFunctionality="003"
flavour="001"
version="12" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.