ATMDepositCompletionAcknowledgementV01

catp.015.001.01

The ATMDepositCompletionAcknowledgement message is sent by an acquirer or its agent to an ATM to acknowledge the receipt of an ATMDepositCompletionAdvice 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
%% ATMDepositCompletionAcknowledgementV01 recursion level 0 with max 0
ATMDepositCompletionAcknowledgementV01 *-- "1..1" Header32 : Header
ATMDepositCompletionAcknowledgementV01 *-- "0..1" ContentInformationType10 : ProtectedATMDepositCompletionAcknowledgement
ATMDepositCompletionAcknowledgementV01 *-- "0..1" ATMDepositCompletionAcknowledgement1 : ATMDepositCompletionAcknowledgement
ATMDepositCompletionAcknowledgementV01 *-- "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

ProtectedATMDepositCompletionAcknowledgement 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

ATMDepositCompletionAcknowledgement building block

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

classDiagram
   direction tb
%% ATMDepositCompletionAcknowledgement1 recursion level 0 with max 1
ATMDepositCompletionAcknowledgement1 *-- "1..1" AutomatedTellerMachine3 : ATM
ATMDepositCompletionAcknowledgement1 *-- "1..1" ATMContext12 : Context
ATMDepositCompletionAcknowledgement1 *-- "1..1" ATMTransaction18 : Transaction
%% AutomatedTellerMachine3 recursion level 1 with max 1
class AutomatedTellerMachine3{
    Identification IsoMax35Text
    AdditionalIdentification IsoMax35Text
    SequenceNumber IsoMax35Text
}
AutomatedTellerMachine3 *-- "0..1" PostalAddress17 : Location
%% ATMContext12 recursion level 1 with max 1
class ATMContext12{
    SessionReference IsoMax35Text
}
ATMContext12 *-- "0..1" ATMService13 : Service
%% ATMTransaction18 recursion level 1 with max 1
class ATMTransaction18{
    Response Response4Code
    ResponseReason ResultDetail4Code
    ICCRelatedData IsoMax10000Binary
}
ATMTransaction18 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
ATMTransaction18 *-- "0..0" ATMCommand7 : Command
  

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

classDiagram
    class IOuterRecord
    ATMDepositCompletionAcknowledgementV01 --|> IOuterRecord : Implements
    ATMDepositCompletionAcknowledgementV01Document --|> IOuterDocument~ATMDepositCompletionAcknowledgementV01~ : Implements
    class IOuterDocument~ATMDepositCompletionAcknowledgementV01~ {
        ATMDepositCompletionAcknowledgementV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    ATMDepositCompletionAcknowledgementV01Document *-- ATMDepositCompletionAcknowledgementV01 : 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.015.001.01">
    <ATMDpstCmpltnAck>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <PrtctdATMDpstCmpltnAck>
            <!-- ProtectedATMDepositCompletionAcknowledgement inner content -->
        </PrtctdATMDpstCmpltnAck>
        <ATMDpstCmpltnAck>
            <!-- ATMDepositCompletionAcknowledgement inner content -->
        </ATMDpstCmpltnAck>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </ATMDpstCmpltnAck>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_YEXqoK4REeWZgJQOa6iKCQ"
  name="ATMDepositCompletionAcknowledgementV01"
  definition="The ATMDepositCompletionAcknowledgement message is sent by an acquirer or its agent to an ATM to acknowledge the receipt of an ATMDepositCompletionAdvice message."
  registrationStatus="Registered"
  messageSet="_wx2hAK1hEeWMg5rOByfExw"
  xmlTag="ATMDpstCmpltnAck"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_ho578K4REeWZgJQOa6iKCQ"
    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="_mHoKAK4REeWZgJQOa6iKCQ"
    name="ProtectedATMDepositCompletionAcknowledgement"
    definition="Encrypted body of the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PrtctdATMDpstCmpltnAck"
    complexType="_UfeMUWizEeS87LmvcA55sg" />
  <messageBuildingBlock
    xmi:id="_qZQXQK4REeWZgJQOa6iKCQ"
    name="ATMDepositCompletionAcknowledgement"
    definition="Information related to the acknowledgement of an ATM deposit transaction from the ATM manager."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="ATMDpstCmpltnAck"
    complexType="_tSpmQK4REeWZgJQOa6iKCQ" />
  <messageBuildingBlock
    xmi:id="_DgzqgK4SEeWZgJQOa6iKCQ"
    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="015"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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