caam.009.001.01
The ATMReconciliationAdvice message is sent by an ATM to an acquirer or its agent to send all the counters of the ATM. It can be sent by an operator function or as a response of a command sent by an agent or a server.
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
%% ATMReconciliationAdviceV01 recursion level 0 with max 0
ATMReconciliationAdviceV01 *-- "1..1" Header21 : Header
ATMReconciliationAdviceV01 *-- "0..1" ContentInformationType10 : ProtectedATMReconciliationAdvice
ATMReconciliationAdviceV01 *-- "0..1" ATMReconciliationAdvice1 : ATMReconciliationAdvice
ATMReconciliationAdviceV01 *-- "0..1" ContentInformationType15 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Information related to the protocol management on a segment of the path from the ATM to the acquirer. Information related to the protocol management on a segment of the path from the ATM to the acquirer. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Header21 recursion level 0 with max 1
class Header21{
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoMax3NumericText
ReTransmissionCounter IsoNumber
CreationDateTime IsoISODateTime
InitiatingParty IsoMax35Text
RecipientParty IsoMax35Text
ProcessState IsoMax35Text
}
Header21 *-- "1..1" ATMMessageFunction1 : MessageFunction
Header21 *-- "0..0" Traceability4 : Traceability
%% ATMMessageFunction1 recursion level 1 with max 1
class ATMMessageFunction1{
Function MessageFunction7Code
ATMServiceCode IsoMax35Text
HostServiceCode IsoMax35Text
}
%% Traceability4 recursion level 1 with max 1
class Traceability4{
SequenceNumber IsoMax35Text
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability4 *-- "1..1" GenericIdentification77 : RelayIdentification
Header21 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | ATMMessageFunction1 - Required 1..1 |
| ProtocolVersion | Version of the ATM protocol specifications. | IsoMax6Text - Required 1..1 |
| ExchangeIdentification | Unique identification of an exchange occurrence. | IsoMax3NumericText - Required 1..1 |
| ReTransmissionCounter | Retransmission counter of this advice, 0 for the first transmission. | IsoNumber - Optional 0..1 |
| CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Required 1..1 |
| InitiatingParty | Unique identification of the partner that has initiated the exchange. | IsoMax35Text - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | IsoMax35Text - Optional 0..1 |
| ProcessState | State of the sender of the message inside the process flow. | IsoMax35Text - Optional 0..1 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability4 - Unknown 0..0 |
ProtectedATMReconciliationAdvice building block
Encrypted body of the message. General cryptographic message syntax (CMS) containing encrypted data. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ContentInformationType10 recursion level 0 with max 1
class ContentInformationType10{
ContentType ContentType2Code
}
ContentInformationType10 *-- "1..1" EnvelopedData4 : EnvelopedData
%% EnvelopedData4 recursion level 1 with max 1
class EnvelopedData4{
Version IsoNumber
}
EnvelopedData4 *-- "1..0" IRecipient4Choice : Recipient
EnvelopedData4 *-- "0..1" EncryptedContent3 : EncryptedContent
ContentInformationType10 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ContentType | Type of data protection. | ContentType2Code - Required 1..1 |
| EnvelopedData | Data protection by encryption or by a digital envelope, with an encryption key. | EnvelopedData4 - Required 1..1 |
ATMReconciliationAdvice building block
Information related to the reconciliation of an ATM. Information related to the reconciliation of an ATM. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ATMReconciliationAdvice1 recursion level 0 with max 1
ATMReconciliationAdvice1 *-- "1..1" ATMEnvironment10 : Environment
ATMReconciliationAdvice1 *-- "0..0" ATMCommand5 : CommandResult
ATMReconciliationAdvice1 *-- "0..1" ATMCommand6 : CommandContext
ATMReconciliationAdvice1 *-- "1..1" ATMTransaction11 : Transaction
%% ATMEnvironment10 recursion level 1 with max 1
class ATMEnvironment10{
ATMManagerIdentification IsoMax35Text
}
ATMEnvironment10 *-- "0..1" Acquirer7 : Acquirer
ATMEnvironment10 *-- "0..1" TerminalHosting1 : HostingEntity
ATMEnvironment10 *-- "1..1" AutomatedTellerMachine8 : ATM
%% ATMCommand5 recursion level 1 with max 1
class ATMCommand5{
Type ATMCommand3Code
RequiredDateTime IsoISODateTime
ProcessedDateTime IsoISODateTime
Result TerminalManagementActionResult2Code
AdditionalErrorInformation IsoMax140Text
}
ATMCommand5 *-- "0..1" ATMCommandIdentification1 : CommandIdentification
%% ATMCommand6 recursion level 1 with max 1
class ATMCommand6{
Type ATMCommand3Code
}
ATMCommand6 *-- "0..1" ATMCommandIdentification1 : CommandIdentification
%% ATMTransaction11 recursion level 1 with max 1
class ATMTransaction11{
TypeOfOperation ATMOperation1Code
ReconciliationIdentification IsoMax35Text
RetainedCard IsoNumber
AdditionalTransactionInformation IsoMax140Text
}
ATMTransaction11 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
ATMTransaction11 *-- "0..0" ATMTotals1 : ATMTotals
ATMTransaction11 *-- "0..0" ATMCassette1 : Cassette
ATMTransaction11 *-- "0..0" ATMTotals3 : TransactionTotals
ATMReconciliationAdvice1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the ATM. | ATMEnvironment10 - Required 1..1 |
| CommandResult | Command result for reinitialisation of the transaction counters. | ATMCommand5 - Unknown 0..0 |
| CommandContext | Party which has requested the reconciliation. | ATMCommand6 - Optional 0..1 |
| Transaction | Information about the reconciliation request. | ATMTransaction11 - Required 1..1 |
SecurityTrailer building block
Trailer of the message containing a MAC. General cryptographic message syntax (CMS) containing authenticated data. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ContentInformationType15 recursion level 0 with max 1
class ContentInformationType15{
ContentType ContentType2Code
}
ContentInformationType15 *-- "1..1" AuthenticatedData4 : AuthenticatedData
%% AuthenticatedData4 recursion level 1 with max 1
class AuthenticatedData4{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData4 *-- "1..0" IRecipient4Choice : Recipient
AuthenticatedData4 *-- "1..1" AlgorithmIdentification15 : MACAlgorithm
AuthenticatedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
ContentInformationType15 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). | AuthenticatedData4 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the ATMReconciliationAdviceV01 implementation follows a specific implementaiton pattern. First of all, ATMReconciliationAdviceV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ATMReconciliationAdviceV01Document implements IOuterDocument. Because ATMReconciliationAdviceV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ATMReconciliationAdviceV01.
classDiagram
class IOuterRecord
ATMReconciliationAdviceV01 --|> IOuterRecord : Implements
ATMReconciliationAdviceV01Document --|> IOuterDocument~ATMReconciliationAdviceV01~ : Implements
class IOuterDocument~ATMReconciliationAdviceV01~ {
ATMReconciliationAdviceV01 Message
}
Document wrapper for serialization
The only real purpose ATMReconciliationAdviceV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caam.009.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ATMReconciliationAdviceV01.ToDocument() method. The returned ATMReconciliationAdviceV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ATMReconciliationAdviceV01Document *-- ATMReconciliationAdviceV01 : 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:caam.009.001.01">
<ATMRcncltnAdvc>
<Hdr>
<!-- Header inner content -->
</Hdr>
<PrtctdATMRcncltnAdvc>
<!-- ProtectedATMReconciliationAdvice inner content -->
</PrtctdATMRcncltnAdvc>
<ATMRcncltnAdvc>
<!-- ATMReconciliationAdvice inner content -->
</ATMRcncltnAdvc>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</ATMRcncltnAdvc>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_Gvo5oIttEeSLQutgI1Ulfw"
nextVersions="_HD6BMa47EeWRfYPBaeOY8w"
name="ATMReconciliationAdviceV01"
definition="The ATMReconciliationAdvice message is sent by an ATM to an acquirer or its agent to send all the counters of the ATM. It can be sent by an operator function or as a response of a command sent by an agent or a server."
registrationStatus="Registered"
messageSet="_lVeMdARsEeWTJNHF-ohSqw"
xmlTag="ATMRcncltnAdvc"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_TVDiAIttEeSLQutgI1Ulfw"
name="Header"
definition="Information related to the protocol management on a segment of the path from the ATM to the acquirer."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_RdTnAYqNEeSRT5rEzcAHEw" />
<messageBuildingBlock
xmi:id="_ZN6LwIttEeSLQutgI1Ulfw"
name="ProtectedATMReconciliationAdvice"
definition="Encrypted body of the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PrtctdATMRcncltnAdvc"
complexType="_UfeMUWizEeS87LmvcA55sg" />
<messageBuildingBlock
xmi:id="_huUtoIttEeSLQutgI1Ulfw"
name="ATMReconciliationAdvice"
definition="Information related to the reconciliation of an ATM."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="ATMRcncltnAdvc"
complexType="_bn_okIttEeSLQutgI1Ulfw" />
<messageBuildingBlock
xmi:id="_lmlYoIttEeSLQutgI1Ulfw"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_uSOuUCrHEeWRf8RNsvC5fQ" />
<messageDefinitionIdentifier
businessArea="caam"
messageFunctionality="009"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.