caam.011.001.01
The ATMExceptionAdvice message is sent by an ATM to an acquirer or its agent to inform of that an exception occurred outside a service.
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
%% ATMExceptionAdviceV01 recursion level 0 with max 0
ATMExceptionAdviceV01 *-- "1..1" Header32 : Header
ATMExceptionAdviceV01 *-- "0..1" ContentInformationType10 : ProtectedATMExceptionAdvice
ATMExceptionAdviceV01 *-- "0..1" ATMExceptionAdvice1 : ATMExceptionAdvice
ATMExceptionAdviceV01 *-- "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
%% Header32 recursion level 0 with max 1
class Header32{
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoMax3NumericText
ReTransmissionCounter IsoNumber
CreationDateTime IsoISODateTime
InitiatingParty IsoMax35Text
RecipientParty IsoMax35Text
ProcessState IsoMax35Text
}
Header32 *-- "1..1" ATMMessageFunction2 : MessageFunction
Header32 *-- "0..0" Traceability4 : Traceability
%% ATMMessageFunction2 recursion level 1 with max 1
class ATMMessageFunction2{
Function MessageFunction11Code
ATMServiceCode IsoMax35Text
HostServiceCode IsoMax35Text
}
%% Traceability4 recursion level 1 with max 1
class Traceability4{
SequenceNumber IsoMax35Text
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability4 *-- "1..1" GenericIdentification77 : RelayIdentification
Header32 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | ATMMessageFunction2 - 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 |
ProtectedATMExceptionAdvice 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 |
ATMExceptionAdvice building block
Information related to exceptions occurring on the ATM. Information related to exceptions occurring on the ATM. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ATMExceptionAdvice1 recursion level 0 with max 1
ATMExceptionAdvice1 *-- "0..1" ATMEnvironment16 : Environment
ATMExceptionAdvice1 *-- "0..1" ATMContext20 : Context
ATMExceptionAdvice1 *-- "1..1" ATMTransaction27 : Transaction
%% ATMEnvironment16 recursion level 1 with max 1
class ATMEnvironment16{
ATMManagerIdentification IsoMax35Text
}
ATMEnvironment16 *-- "0..1" Acquirer7 : Acquirer
ATMEnvironment16 *-- "0..1" TerminalHosting1 : HostingEntity
ATMEnvironment16 *-- "1..1" AutomatedTellerMachine9 : ATM
ATMEnvironment16 *-- "0..1" ATMCustomer6 : Customer
ATMEnvironment16 *-- "0..1" PaymentCard23 : Card
%% ATMContext20 recursion level 1 with max 1
class ATMContext20{
SessionReference IsoMax35Text
}
ATMContext20 *-- "1..1" ATMService24 : Service
%% ATMTransaction27 recursion level 1 with max 1
class ATMTransaction27{
ReconciliationIdentification IsoMax35Text
Exception FailureReason8Code
ExceptionDetail IsoMax70Text
ElectronicPurseBalance IsoCurrencyAndAmount
}
ATMTransaction27 *-- "0..1" TransactionIdentifier1 : TransactionIdentification
ATMExceptionAdvice1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the exception. | ATMEnvironment16 - Optional 0..1 |
| Context | Context of the exception. | ATMContext20 - Optional 0..1 |
| Transaction | Transaction for which the exception is sent. | ATMTransaction27 - 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 ATMExceptionAdviceV01 implementation follows a specific implementaiton pattern. First of all, ATMExceptionAdviceV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ATMExceptionAdviceV01Document implements IOuterDocument. Because ATMExceptionAdviceV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ATMExceptionAdviceV01.
classDiagram
class IOuterRecord
ATMExceptionAdviceV01 --|> IOuterRecord : Implements
ATMExceptionAdviceV01Document --|> IOuterDocument~ATMExceptionAdviceV01~ : Implements
class IOuterDocument~ATMExceptionAdviceV01~ {
ATMExceptionAdviceV01 Message
}
Document wrapper for serialization
The only real purpose ATMExceptionAdviceV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caam.011.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ATMExceptionAdviceV01.ToDocument() method. The returned ATMExceptionAdviceV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ATMExceptionAdviceV01Document *-- ATMExceptionAdviceV01 : 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.011.001.01">
<ATMXcptnAdvc>
<Hdr>
<!-- Header inner content -->
</Hdr>
<PrtctdATMXcptnAdvc>
<!-- ProtectedATMExceptionAdvice inner content -->
</PrtctdATMXcptnAdvc>
<ATMXcptnAdvc>
<!-- ATMExceptionAdvice inner content -->
</ATMXcptnAdvc>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</ATMXcptnAdvc>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_i58PwK5CEeWCgYcWSNgX5g"
name="ATMExceptionAdviceV01"
definition="The ATMExceptionAdvice message is sent by an ATM to an acquirer or its agent to inform of that an exception occurred outside a service."
registrationStatus="Registered"
messageSet="_wx2hAK1hEeWMg5rOByfExw"
xmlTag="ATMXcptnAdvc"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_uFaCoK5CEeWCgYcWSNgX5g"
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="_4Wfn0a4JEeWZgJQOa6iKCQ" />
<messageBuildingBlock
xmi:id="_MJAZIK5DEeWCgYcWSNgX5g"
name="ProtectedATMExceptionAdvice"
definition="Encrypted body of the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PrtctdATMXcptnAdvc"
complexType="_UfeMUWizEeS87LmvcA55sg" />
<messageBuildingBlock
xmi:id="_4n370K5CEeWCgYcWSNgX5g"
name="ATMExceptionAdvice"
definition="Information related to exceptions occurring on the ATM."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="ATMXcptnAdvc"
complexType="_92OQAK5CEeWCgYcWSNgX5g" />
<messageBuildingBlock
xmi:id="_PYXwwK5GEeWCgYcWSNgX5g"
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="011"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.