catp.003.001.01
The ATMWithdrawalCompletionAdvice message is sent by an ATM to an acquirer or its agent to inform of the result of a withdrawal transaction at an ATM. If the ATM is configured to only send negative completion, a generic completion message should be used instead of ATMCompletionAdvice.
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
%% ATMWithdrawalCompletionAdviceV01 recursion level 0 with max 0
ATMWithdrawalCompletionAdviceV01 *-- "1..1" Header21 : Header
ATMWithdrawalCompletionAdviceV01 *-- "0..1" ContentInformationType10 : ProtectedATMWithdrawalCompletionAdvice
ATMWithdrawalCompletionAdviceV01 *-- "0..1" ATMWithdrawalCompletionAdvice1 : ATMWithdrawalCompletionAdvice
ATMWithdrawalCompletionAdviceV01 *-- "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 |
ProtectedATMWithdrawalCompletionAdvice 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 |
ATMWithdrawalCompletionAdvice building block
Information related to the completion of a withdrawal transaction on the ATM. Information related to the completion of a withdrawal on the ATM. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ATMWithdrawalCompletionAdvice1 recursion level 0 with max 1
ATMWithdrawalCompletionAdvice1 *-- "1..1" ATMEnvironment3 : Environment
ATMWithdrawalCompletionAdvice1 *-- "1..1" ATMContext2 : Context
ATMWithdrawalCompletionAdvice1 *-- "1..1" ATMTransaction3 : Transaction
%% ATMEnvironment3 recursion level 1 with max 1
class ATMEnvironment3{
ATMManagerIdentification IsoMax35Text
}
ATMEnvironment3 *-- "0..1" Acquirer7 : Acquirer
ATMEnvironment3 *-- "0..1" TerminalHosting1 : HostingEntity
ATMEnvironment3 *-- "1..1" AutomatedTellerMachine1 : ATM
ATMEnvironment3 *-- "1..1" ATMCustomer3 : Customer
ATMEnvironment3 *-- "0..1" PaymentCard17 : Card
%% ATMContext2 recursion level 1 with max 1
class ATMContext2{
SessionReference IsoMax35Text
}
ATMContext2 *-- "0..1" ATMService2 : Service
%% ATMTransaction3 recursion level 1 with max 1
class ATMTransaction3{
TransactionStatus ATMTransactionStatus1Code
MultiBundle IsoTrueFalseIndicator
BundlePresentedAmount IsoImpliedCurrencyAndAmount
PresentedAmountStatus ATMTransactionStatus2Code
Incident FailureReason4Code
IncidentDetail IsoMax70Text
ReconciliationIdentification IsoMax35Text
TotalAuthorisedAmount IsoImpliedCurrencyAndAmount
TotalRequestedAmount IsoImpliedCurrencyAndAmount
RequestedReceipt IsoTrueFalseIndicator
ReceiptPrinted IsoTrueFalseIndicator
CapturedCard IsoTrueFalseIndicator
ICCRelatedData IsoMax10000Binary
}
ATMTransaction3 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
ATMTransaction3 *-- "0..1" CardAccount5 : AccountData
ATMTransaction3 *-- "0..1" ContentInformationType10 : ProtectedAccountData
ATMTransaction3 *-- "1..1" AmountAndCurrency1 : TotalPresentedAmount
ATMTransaction3 *-- "0..1" DetailedAmount12 : DetailedRequestedAmount
ATMTransaction3 *-- "0..1" CurrencyConversion4 : CurrencyConversion
ATMTransaction3 *-- "0..0" DetailedAmount13 : AdditionalCharge
ATMTransaction3 *-- "0..1" ATMTransactionAmounts2 : Limits
ATMTransaction3 *-- "0..1" AuthorisationResult9 : AuthorisationResult
ATMTransaction3 *-- "0..0" ATMTotals1 : ATMTotals
ATMTransaction3 *-- "0..0" ATMCassette1 : Cassette
ATMWithdrawalCompletionAdvice1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the withdrawal transaction. | ATMEnvironment3 - Required 1..1 |
| Context | Context in which the transaction is performed. | ATMContext2 - Required 1..1 |
| Transaction | Withdrawal transaction for which the completion is sent. | ATMTransaction3 - 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 ATMWithdrawalCompletionAdviceV01 implementation follows a specific implementaiton pattern. First of all, ATMWithdrawalCompletionAdviceV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ATMWithdrawalCompletionAdviceV01Document implements IOuterDocument. Because ATMWithdrawalCompletionAdviceV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ATMWithdrawalCompletionAdviceV01.
classDiagram
class IOuterRecord
ATMWithdrawalCompletionAdviceV01 --|> IOuterRecord : Implements
ATMWithdrawalCompletionAdviceV01Document --|> IOuterDocument~ATMWithdrawalCompletionAdviceV01~ : Implements
class IOuterDocument~ATMWithdrawalCompletionAdviceV01~ {
ATMWithdrawalCompletionAdviceV01 Message
}
Document wrapper for serialization
The only real purpose ATMWithdrawalCompletionAdviceV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:catp.003.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ATMWithdrawalCompletionAdviceV01.ToDocument() method. The returned ATMWithdrawalCompletionAdviceV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ATMWithdrawalCompletionAdviceV01Document *-- ATMWithdrawalCompletionAdviceV01 : 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.003.001.01">
<ATMWdrwlCmpltnAdvc>
<Hdr>
<!-- Header inner content -->
</Hdr>
<PrtctdATMWdrwlCmpltnAdvc>
<!-- ProtectedATMWithdrawalCompletionAdvice inner content -->
</PrtctdATMWdrwlCmpltnAdvc>
<ATMWdrwlCmpltnAdvc>
<!-- ATMWithdrawalCompletionAdvice inner content -->
</ATMWdrwlCmpltnAdvc>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</ATMWdrwlCmpltnAdvc>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_-VAgcIqMEeSRT5rEzcAHEw"
nextVersions="_zg0SUa4JEeWZgJQOa6iKCQ"
name="ATMWithdrawalCompletionAdviceV01"
definition="The ATMWithdrawalCompletionAdvice message is sent by an ATM to an acquirer or its agent to inform of the result of a withdrawal transaction at an ATM.
If the ATM is configured to only send negative completion, a generic completion message should be used instead of ATMCompletionAdvice."
registrationStatus="Registered"
messageSet="_lVeMdARsEeWTJNHF-ohSqw"
xmlTag="ATMWdrwlCmpltnAdvc"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_Xl_cgIqNEeSRT5rEzcAHEw"
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="_BzKz8IqOEeSRT5rEzcAHEw"
name="ProtectedATMWithdrawalCompletionAdvice"
definition="Encrypted body of the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PrtctdATMWdrwlCmpltnAdvc"
complexType="_UfeMUWizEeS87LmvcA55sg" />
<messageBuildingBlock
xmi:id="_PiQaIIqOEeSRT5rEzcAHEw"
name="ATMWithdrawalCompletionAdvice"
definition="Information related to the completion of a withdrawal transaction on the ATM."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="ATMWdrwlCmpltnAdvc"
complexType="_E6Ru0IqOEeSRT5rEzcAHEw" />
<messageBuildingBlock
xmi:id="_abo-gIqOEeSRT5rEzcAHEw"
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="003"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.