ATMExceptionAcknowledgementV01

caam.012.001.01

The ATMExceptionAcknowledgement message is sent by an acquirer or its agent to an ATM to acknowledge the receipt of an ATMExceptionAdvice message.

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
%% ATMExceptionAcknowledgementV01 recursion level 0 with max 0
ATMExceptionAcknowledgementV01 *-- "1..1" Header32 : Header
ATMExceptionAcknowledgementV01 *-- "0..1" ContentInformationType10 : ProtectedATMExceptionAcknowledgement
ATMExceptionAcknowledgementV01 *-- "0..1" ATMExceptionAcknowledgement1 : ATMExceptionAcknowledgement
ATMExceptionAcknowledgementV01 *-- "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

ProtectedATMExceptionAcknowledgement 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

ATMExceptionAcknowledgement building block

Information related to the acknowledgement of an ATM exception. Information related to the acknowledgement of an ATM exception. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ATMExceptionAcknowledgement1 recursion level 0 with max 1
ATMExceptionAcknowledgement1 *-- "1..1" AutomatedTellerMachine3 : ATM
ATMExceptionAcknowledgement1 *-- "1..1" ATMContext20 : Context
ATMExceptionAcknowledgement1 *-- "1..1" ATMTransaction28 : Transaction
%% AutomatedTellerMachine3 recursion level 1 with max 1
class AutomatedTellerMachine3{
    Identification IsoMax35Text
    AdditionalIdentification IsoMax35Text
    SequenceNumber IsoMax35Text
}
AutomatedTellerMachine3 *-- "0..1" PostalAddress17 : Location
%% ATMContext20 recursion level 1 with max 1
class ATMContext20{
    SessionReference IsoMax35Text
}
ATMContext20 *-- "1..1" ATMService24 : Service
%% ATMTransaction28 recursion level 1 with max 1
class ATMTransaction28{
    Response Response2Code
}
ATMTransaction28 *-- "0..1" TransactionIdentifier1 : TransactionIdentification
ATMTransaction28 *-- "0..0" ATMCommand7 : Command
  

ATMExceptionAcknowledgement1 members

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

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the ATMExceptionAcknowledgementV01 implementation follows a specific implementaiton pattern. First of all, ATMExceptionAcknowledgementV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ATMExceptionAcknowledgementV01Document implements IOuterDocument. Because ATMExceptionAcknowledgementV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ATMExceptionAcknowledgementV01.

classDiagram
    class IOuterRecord
    ATMExceptionAcknowledgementV01 --|> IOuterRecord : Implements
    ATMExceptionAcknowledgementV01Document --|> IOuterDocument~ATMExceptionAcknowledgementV01~ : Implements
    class IOuterDocument~ATMExceptionAcknowledgementV01~ {
        ATMExceptionAcknowledgementV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    ATMExceptionAcknowledgementV01Document *-- ATMExceptionAcknowledgementV01 : 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.012.001.01">
    <ATMXcptnAck>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <PrtctdATMXcptnAck>
            <!-- ProtectedATMExceptionAcknowledgement inner content -->
        </PrtctdATMXcptnAck>
        <ATMXcptnAck>
            <!-- ATMExceptionAcknowledgement inner content -->
        </ATMXcptnAck>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </ATMXcptnAck>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_YFLI0K5GEeWCgYcWSNgX5g"
  name="ATMExceptionAcknowledgementV01"
  definition="The ATMExceptionAcknowledgement message is sent by an acquirer or its agent to an ATM to acknowledge the receipt of an ATMExceptionAdvice message."
  registrationStatus="Registered"
  messageSet="_wx2hAK1hEeWMg5rOByfExw"
  xmlTag="ATMXcptnAck"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_fpPXMK5GEeWCgYcWSNgX5g"
    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="_k_u6wK5GEeWCgYcWSNgX5g"
    name="ProtectedATMExceptionAcknowledgement"
    definition="Encrypted body of the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PrtctdATMXcptnAck"
    complexType="_UfeMUWizEeS87LmvcA55sg" />
  <messageBuildingBlock
    xmi:id="_ogUFkK5GEeWCgYcWSNgX5g"
    name="ATMExceptionAcknowledgement"
    definition="Information related to the acknowledgement of an ATM exception."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="ATMXcptnAck"
    complexType="_slQhsK5GEeWCgYcWSNgX5g" />
  <messageBuildingBlock
    xmi:id="_kRgtYK5HEeWCgYcWSNgX5g"
    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="012"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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