ATMCompletionAcknowledgementV01

catp.009.001.01

The ATMCompletionAcknowledgement message is sent by an acquirer or its agent to an ATM to acknowledge the receipt of an ATMCompletionAdvice 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
%% ATMCompletionAcknowledgementV01 recursion level 0 with max 0
ATMCompletionAcknowledgementV01 *-- "1..1" Header21 : Header
ATMCompletionAcknowledgementV01 *-- "0..1" ContentInformationType10 : ProtectedATMCompletionAcknowledgement
ATMCompletionAcknowledgementV01 *-- "0..1" ATMCompletionAcknowledgement1 : ATMCompletionAcknowledgement
ATMCompletionAcknowledgementV01 *-- "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

ProtectedATMCompletionAcknowledgement 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

ATMCompletionAcknowledgement building block

Information related to the acknowledgement of an ATM completion on the ATM. manager. Information related to the acknowledgement of an ATM completion from the ATM manager. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ATMCompletionAcknowledgement1 recursion level 0 with max 1
ATMCompletionAcknowledgement1 *-- "1..1" AutomatedTellerMachine3 : ATM
ATMCompletionAcknowledgement1 *-- "1..1" ATMContext3 : Context
ATMCompletionAcknowledgement1 *-- "1..1" ATMTransaction4 : Transaction
%% AutomatedTellerMachine3 recursion level 1 with max 1
class AutomatedTellerMachine3{
    Identification IsoMax35Text
    AdditionalIdentification IsoMax35Text
    SequenceNumber IsoMax35Text
}
AutomatedTellerMachine3 *-- "0..1" PostalAddress17 : Location
%% ATMContext3 recursion level 1 with max 1
class ATMContext3{
    SessionReference IsoMax35Text
}
ATMContext3 *-- "1..1" ATMService3 : Service
%% ATMTransaction4 recursion level 1 with max 1
class ATMTransaction4{
    Response Response4Code
    ResponseReason ResultDetail2Code
    ICCRelatedData IsoMax10000Binary
}
ATMTransaction4 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
ATMTransaction4 *-- "0..0" ATMCommand1 : Command
  

ATMCompletionAcknowledgement1 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 ATMCompletionAcknowledgementV01 implementation follows a specific implementaiton pattern. First of all, ATMCompletionAcknowledgementV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ATMCompletionAcknowledgementV01Document implements IOuterDocument. Because ATMCompletionAcknowledgementV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ATMCompletionAcknowledgementV01.

classDiagram
    class IOuterRecord
    ATMCompletionAcknowledgementV01 --|> IOuterRecord : Implements
    ATMCompletionAcknowledgementV01Document --|> IOuterDocument~ATMCompletionAcknowledgementV01~ : Implements
    class IOuterDocument~ATMCompletionAcknowledgementV01~ {
        ATMCompletionAcknowledgementV01 Message
     }
  

Document wrapper for serialization

The only real purpose ATMCompletionAcknowledgementV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:catp.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 ATMCompletionAcknowledgementV01.ToDocument() method. The returned ATMCompletionAcknowledgementV01Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    ATMCompletionAcknowledgementV01Document *-- ATMCompletionAcknowledgementV01 : 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:catp.009.001.01">
    <ATMCmpltnAck>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <PrtctdATMCmpltnAck>
            <!-- ProtectedATMCompletionAcknowledgement inner content -->
        </PrtctdATMCmpltnAck>
        <ATMCmpltnAck>
            <!-- ATMCompletionAcknowledgement inner content -->
        </ATMCmpltnAck>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </ATMCmpltnAck>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_vVWZgIqoEeS4a4abTJTSSw"
  nextVersions="_x3hNsa4TEeWZgJQOa6iKCQ"
  name="ATMCompletionAcknowledgementV01"
  definition="The ATMCompletionAcknowledgement message is sent by an acquirer or its agent to an ATM to acknowledge the receipt of an ATMCompletionAdvice message."
  registrationStatus="Registered"
  messageSet="_lVeMdARsEeWTJNHF-ohSqw"
  xmlTag="ATMCmpltnAck"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_6tbsEIqoEeS4a4abTJTSSw"
    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="__ptY0IqoEeS4a4abTJTSSw"
    name="ProtectedATMCompletionAcknowledgement"
    definition="Encrypted body of the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PrtctdATMCmpltnAck"
    complexType="_UfeMUWizEeS87LmvcA55sg" />
  <messageBuildingBlock
    xmi:id="_OHhtQIqpEeS4a4abTJTSSw"
    name="ATMCompletionAcknowledgement"
    definition="Information related to the acknowledgement of an ATM completion on the ATM. manager."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="ATMCmpltnAck"
    complexType="_EgQRAIqpEeS4a4abTJTSSw" />
  <messageBuildingBlock
    xmi:id="_SU8v8IqpEeS4a4abTJTSSw"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_uSOuUCrHEeWRf8RNsvC5fQ" />
  <messageDefinitionIdentifier
    businessArea="catp"
    messageFunctionality="009"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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