catp.014.001.01
The ATMDepositCompletionAdvice message is sent by an ATM to an acquirer or its agent to inform of the result of a deposit transaction at an ATM. If the ATM is configured to only send negative completion, a generic completion message should be used instead of ATMCompletionAdvice. This message can be used each time a bundle is put in the ATM safe and/or at the end of a multi bundle deposit.
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
%% ATMDepositCompletionAdviceV01 recursion level 0 with max 0
ATMDepositCompletionAdviceV01 *-- "1..1" Header32 : Header
ATMDepositCompletionAdviceV01 *-- "0..1" ContentInformationType10 : ProtectedATMDepositCompletionAdvice
ATMDepositCompletionAdviceV01 *-- "0..1" ATMDepositCompletionAdvice1 : ATMDepositCompletionAdvice
ATMDepositCompletionAdviceV01 *-- "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 |
ProtectedATMDepositCompletionAdvice 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 |
ATMDepositCompletionAdvice building block
Information related to the completion of a deposit transaction on the ATM. Information related to the completion of a deposit transaction on the ATM. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ATMDepositCompletionAdvice1 recursion level 0 with max 1
ATMDepositCompletionAdvice1 *-- "1..1" ATMEnvironment13 : Environment
ATMDepositCompletionAdvice1 *-- "1..1" ATMContext12 : Context
ATMDepositCompletionAdvice1 *-- "1..1" ATMTransaction19 : Transaction
%% ATMEnvironment13 recursion level 1 with max 1
class ATMEnvironment13{
ATMManagerIdentification IsoMax35Text
}
ATMEnvironment13 *-- "0..1" Acquirer7 : Acquirer
ATMEnvironment13 *-- "0..1" TerminalHosting1 : HostingEntity
ATMEnvironment13 *-- "1..1" AutomatedTellerMachine9 : ATM
ATMEnvironment13 *-- "1..1" ATMCustomer6 : Customer
ATMEnvironment13 *-- "0..1" PaymentCard23 : Card
%% ATMContext12 recursion level 1 with max 1
class ATMContext12{
SessionReference IsoMax35Text
}
ATMContext12 *-- "0..1" ATMService13 : Service
%% ATMTransaction19 recursion level 1 with max 1
class ATMTransaction19{
TransactionStatus ATMTransactionStatus1Code
ReconciliationIdentification IsoMax35Text
Incident FailureReason7Code
IncidentDetail IsoMax70Text
TotalAuthorisedAmount IsoImpliedCurrencyAndAmount
TotalRequestedAmount IsoImpliedCurrencyAndAmount
RequestedReceipt IsoTrueFalseIndicator
ReceiptPrinted IsoTrueFalseIndicator
ICCRelatedData IsoMax10000Binary
}
ATMTransaction19 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
ATMTransaction19 *-- "0..1" CardAccount8 : AccountData
ATMTransaction19 *-- "0..1" ContentInformationType10 : ProtectedAccountData
ATMTransaction19 *-- "1..1" AmountAndCurrency1 : TotalDepositedAmount
ATMTransaction19 *-- "0..1" DetailedAmount16 : DetailedRequestedAmount
ATMTransaction19 *-- "0..0" DetailedAmount13 : AdditionalCharge
ATMTransaction19 *-- "0..1" AuthorisationResult13 : AuthorisationResult
ATMTransaction19 *-- "0..0" ATMDepositedMedia1 : DepositedMedia
ATMTransaction19 *-- "0..0" ATMDepositedMedia3 : ToBeReconciledMediaCounters
ATMTransaction19 *-- "0..0" ATMTotals1 : ATMTotals
ATMTransaction19 *-- "0..0" ATMCassette2 : Cassette
ATMDepositCompletionAdvice1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the deposit transaction. | ATMEnvironment13 - Required 1..1 |
| Context | Context in which the transaction is performed. | ATMContext12 - Required 1..1 |
| Transaction | Deposit transaction for which the completion is sent. | ATMTransaction19 - 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 ATMDepositCompletionAdviceV01 implementation follows a specific implementaiton pattern. First of all, ATMDepositCompletionAdviceV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ATMDepositCompletionAdviceV01Document implements IOuterDocument. Because ATMDepositCompletionAdviceV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ATMDepositCompletionAdviceV01.
classDiagram
class IOuterRecord
ATMDepositCompletionAdviceV01 --|> IOuterRecord : Implements
ATMDepositCompletionAdviceV01Document --|> IOuterDocument~ATMDepositCompletionAdviceV01~ : Implements
class IOuterDocument~ATMDepositCompletionAdviceV01~ {
ATMDepositCompletionAdviceV01 Message
}
Document wrapper for serialization
The only real purpose ATMDepositCompletionAdviceV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:catp.014.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ATMDepositCompletionAdviceV01.ToDocument() method. The returned ATMDepositCompletionAdviceV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ATMDepositCompletionAdviceV01Document *-- ATMDepositCompletionAdviceV01 : 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.014.001.01">
<ATMDpstCmpltnAdvc>
<Hdr>
<!-- Header inner content -->
</Hdr>
<PrtctdATMDpstCmpltnAdvc>
<!-- ProtectedATMDepositCompletionAdvice inner content -->
</PrtctdATMDpstCmpltnAdvc>
<ATMDpstCmpltnAdvc>
<!-- ATMDepositCompletionAdvice inner content -->
</ATMDpstCmpltnAdvc>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</ATMDpstCmpltnAdvc>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_-6CQgK4NEeWZgJQOa6iKCQ"
name="ATMDepositCompletionAdviceV01"
definition="The ATMDepositCompletionAdvice message is sent by an ATM to an acquirer or its agent to inform of the result of a deposit transaction at an ATM.
If the ATM is configured to only send negative completion, a generic completion message should be used instead of ATMCompletionAdvice.
This message can be used each time a bundle is put in the ATM safe and/or at the end of a multi bundle deposit."
registrationStatus="Registered"
messageSet="_wx2hAK1hEeWMg5rOByfExw"
xmlTag="ATMDpstCmpltnAdvc"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_Kc-vQK4OEeWZgJQOa6iKCQ"
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="_PzcdoK4OEeWZgJQOa6iKCQ"
name="ProtectedATMDepositCompletionAdvice"
definition="Encrypted body of the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PrtctdATMDpstCmpltnAdvc"
complexType="_UfeMUWizEeS87LmvcA55sg" />
<messageBuildingBlock
xmi:id="_SW544K4OEeWZgJQOa6iKCQ"
name="ATMDepositCompletionAdvice"
definition="Information related to the completion of a deposit transaction on the ATM."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="ATMDpstCmpltnAdvc"
complexType="_YiR2AK4OEeWZgJQOa6iKCQ" />
<messageBuildingBlock
xmi:id="_Vo7qUK4OEeWZgJQOa6iKCQ"
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="014"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.