catp.004.001.01
The ATMWithdrawalCompletionAcknowledgement message is sent by an acquirer or its agent to an ATM to acknowledge the receipt of an ATMWithdrawalCompletionAdvice 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 %% ATMWithdrawalCompletionAcknowledgementV01 recursion level 0 with max 0 ATMWithdrawalCompletionAcknowledgementV01 *-- "1..1" Header21 : Header ATMWithdrawalCompletionAcknowledgementV01 *-- "0..1" ContentInformationType10 : ProtectedATMWithdrawalCompletionAcknowledgement ATMWithdrawalCompletionAcknowledgementV01 *-- "0..1" ATMWithdrawalCompletionAcknowledgement1 : ATMWithdrawalCompletionAcknowledgement ATMWithdrawalCompletionAcknowledgementV01 *-- "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
Member name | Description | Data Type / Multiplicity |
---|---|---|
MessageFunction | Identifies the type of process related to the message. | ATMMessageFunction1 - 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 |
ProtectedATMWithdrawalCompletionAcknowledgement 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 |
ATMWithdrawalCompletionAcknowledgement building block
Information related to the acknowledgement of an ATM withdrawal transaction from the ATM manager. Information related to the acknowledgement of an ATM withdrawal from the ATM manager. For comparison, see the ISO20022 official specification
classDiagram direction tb %% ATMWithdrawalCompletionAcknowledgement1 recursion level 0 with max 1 ATMWithdrawalCompletionAcknowledgement1 *-- "1..1" AutomatedTellerMachine3 : ATM ATMWithdrawalCompletionAcknowledgement1 *-- "1..1" ATMContext2 : Context ATMWithdrawalCompletionAcknowledgement1 *-- "1..1" ATMTransaction4 : Transaction %% AutomatedTellerMachine3 recursion level 1 with max 1 class AutomatedTellerMachine3{ Identification IsoMax35Text AdditionalIdentification IsoMax35Text SequenceNumber IsoMax35Text } AutomatedTellerMachine3 *-- "0..1" PostalAddress17 : Location %% ATMContext2 recursion level 1 with max 1 class ATMContext2{ SessionReference IsoMax35Text } ATMContext2 *-- "0..1" ATMService2 : 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
ATMWithdrawalCompletionAcknowledgement1 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
ATM | ATM information. | AutomatedTellerMachine3 - Required 1..1 |
Context | Context in which the transaction is performed. | ATMContext2 - Required 1..1 |
Transaction | Acknowledgement of the withdrawal completion advice. | ATMTransaction4 - 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 ATMWithdrawalCompletionAcknowledgementV01 implementation follows a specific implementaiton pattern. First of all, ATMWithdrawalCompletionAcknowledgementV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ATMWithdrawalCompletionAcknowledgementV01Document implements IOuterDocument. Because ATMWithdrawalCompletionAcknowledgementV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ATMWithdrawalCompletionAcknowledgementV01.
classDiagram class IOuterRecord ATMWithdrawalCompletionAcknowledgementV01 --|> IOuterRecord : Implements ATMWithdrawalCompletionAcknowledgementV01Document --|> IOuterDocument~ATMWithdrawalCompletionAcknowledgementV01~ : Implements class IOuterDocument~ATMWithdrawalCompletionAcknowledgementV01~ { ATMWithdrawalCompletionAcknowledgementV01 Message }
Document wrapper for serialization
The only real purpose ATMWithdrawalCompletionAcknowledgementV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:catp.004.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ATMWithdrawalCompletionAcknowledgementV01.ToDocument() method. The returned ATMWithdrawalCompletionAcknowledgementV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram ATMWithdrawalCompletionAcknowledgementV01Document *-- ATMWithdrawalCompletionAcknowledgementV01 : 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.004.001.01">
<ATMWdrwlCmpltnAck>
<Hdr>
<!-- Header inner content -->
</Hdr>
<PrtctdATMWdrwlCmpltnAck>
<!-- ProtectedATMWithdrawalCompletionAcknowledgement inner content -->
</PrtctdATMWdrwlCmpltnAck>
<ATMWdrwlCmpltnAck>
<!-- ATMWithdrawalCompletionAcknowledgement inner content -->
</ATMWdrwlCmpltnAck>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</ATMWdrwlCmpltnAck>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_P2qh4IqkEeS4a4abTJTSSw"
nextVersions="_YbuXga4NEeWZgJQOa6iKCQ"
name="ATMWithdrawalCompletionAcknowledgementV01"
definition="The ATMWithdrawalCompletionAcknowledgement message is sent by an acquirer or its agent to an ATM to acknowledge the receipt of an ATMWithdrawalCompletionAdvice message."
registrationStatus="Registered"
messageSet="_lVeMdARsEeWTJNHF-ohSqw"
xmlTag="ATMWdrwlCmpltnAck"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_aFDBcIqkEeS4a4abTJTSSw"
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="_fAp_0IqkEeS4a4abTJTSSw"
name="ProtectedATMWithdrawalCompletionAcknowledgement"
definition="Encrypted body of the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PrtctdATMWdrwlCmpltnAck"
complexType="_UfeMUWizEeS87LmvcA55sg" />
<messageBuildingBlock
xmi:id="_yUgPEIqkEeS4a4abTJTSSw"
name="ATMWithdrawalCompletionAcknowledgement"
definition="Information related to the acknowledgement of an ATM withdrawal transaction from the ATM manager."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="ATMWdrwlCmpltnAck"
complexType="_iAvFoIqkEeS4a4abTJTSSw" />
<messageBuildingBlock
xmi:id="_2jjpcIqkEeS4a4abTJTSSw"
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="004"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.