catp.002.001.01
The ATMWithdrawalResponse message is sent by an acquirer or its agent to an ATM in response to the ATMWithdrawalRequest to inform the ATM of the approval or decline of the withdrawal transaction.
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
%% ATMWithdrawalResponseV01 recursion level 0 with max 0
ATMWithdrawalResponseV01 *-- "1..1" Header20 : Header
ATMWithdrawalResponseV01 *-- "0..1" ContentInformationType10 : ProtectedATMWithdrawalResponse
ATMWithdrawalResponseV01 *-- "0..1" ATMWithdrawalResponse1 : ATMWithdrawalResponse
ATMWithdrawalResponseV01 *-- "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
%% Header20 recursion level 0 with max 1
class Header20{
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoMax3NumericText
CreationDateTime IsoISODateTime
InitiatingParty IsoMax35Text
RecipientParty IsoMax35Text
ProcessState IsoMax35Text
}
Header20 *-- "1..1" ATMMessageFunction1 : MessageFunction
Header20 *-- "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
Header20 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 |
| 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 |
ProtectedATMWithdrawalResponse 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 |
ATMWithdrawalResponse building block
Information related to the response of an ATM withdrawal transaction from an ATM manager. Information related to the response of an ATM withdrawal from an ATM manager. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ATMWithdrawalResponse1 recursion level 0 with max 1
ATMWithdrawalResponse1 *-- "1..1" ATMEnvironment2 : Environment
ATMWithdrawalResponse1 *-- "1..1" ATMContext2 : Context
ATMWithdrawalResponse1 *-- "1..1" ATMTransaction2 : Transaction
%% ATMEnvironment2 recursion level 1 with max 1
ATMEnvironment2 *-- "0..1" Acquirer7 : Acquirer
ATMEnvironment2 *-- "0..1" Acquirer8 : ATMManager
ATMEnvironment2 *-- "0..1" TerminalHosting1 : HostingEntity
ATMEnvironment2 *-- "1..1" AutomatedTellerMachine2 : ATM
ATMEnvironment2 *-- "1..1" ATMCustomer2 : Customer
ATMEnvironment2 *-- "0..1" ContentInformationType10 : ProtectedCardData
ATMEnvironment2 *-- "0..1" PlainCardData14 : PlainCardData
%% ATMContext2 recursion level 1 with max 1
class ATMContext2{
SessionReference IsoMax35Text
}
ATMContext2 *-- "0..1" ATMService2 : Service
%% ATMTransaction2 recursion level 1 with max 1
class ATMTransaction2{
ReconciliationIdentification IsoMax35Text
CompletionRequired IsoTrueFalseIndicator
TotalRequestedAmount IsoImpliedCurrencyAndAmount
MixType IsoMax35Text
ICCRelatedData IsoMax10000Binary
}
ATMTransaction2 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
ATMTransaction2 *-- "0..1" CardAccount4 : AccountData
ATMTransaction2 *-- "0..1" ContentInformationType10 : ProtectedAccountData
ATMTransaction2 *-- "1..1" AmountAndCurrency1 : TotalAuthorisedAmount
ATMTransaction2 *-- "0..1" DetailedAmount12 : DetailedRequestedAmount
ATMTransaction2 *-- "0..1" CurrencyConversion4 : CurrencyConversion
ATMTransaction2 *-- "0..0" DetailedAmount13 : AdditionalCharge
ATMTransaction2 *-- "0..1" ATMTransactionAmounts2 : Limits
ATMTransaction2 *-- "0..0" ATMMediaMix1 : Mix
ATMTransaction2 *-- "1..1" AuthorisationResult9 : AuthorisationResult
ATMTransaction2 *-- "0..0" ATMCommand1 : Command
ATMWithdrawalResponse1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the withdrawal transaction. | ATMEnvironment2 - Required 1..1 |
| Context | Context in which the transaction is performed. | ATMContext2 - Required 1..1 |
| Transaction | Response to the withdrawal transaction request. | ATMTransaction2 - 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 ATMWithdrawalResponseV01 implementation follows a specific implementaiton pattern. First of all, ATMWithdrawalResponseV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ATMWithdrawalResponseV01Document implements IOuterDocument. Because ATMWithdrawalResponseV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ATMWithdrawalResponseV01.
classDiagram
class IOuterRecord
ATMWithdrawalResponseV01 --|> IOuterRecord : Implements
ATMWithdrawalResponseV01Document --|> IOuterDocument~ATMWithdrawalResponseV01~ : Implements
class IOuterDocument~ATMWithdrawalResponseV01~ {
ATMWithdrawalResponseV01 Message
}
Document wrapper for serialization
The only real purpose ATMWithdrawalResponseV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:catp.002.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ATMWithdrawalResponseV01.ToDocument() method. The returned ATMWithdrawalResponseV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ATMWithdrawalResponseV01Document *-- ATMWithdrawalResponseV01 : 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.002.001.01">
<ATMWdrwlRspn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<PrtctdATMWdrwlRspn>
<!-- ProtectedATMWithdrawalResponse inner content -->
</PrtctdATMWdrwlRspn>
<ATMWdrwlRspn>
<!-- ATMWithdrawalResponse inner content -->
</ATMWdrwlRspn>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</ATMWdrwlRspn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_yPVcAIp0EeS3NqNpgnMh2w"
nextVersions="_q6Vxsa16EeWMg5rOByfExw"
name="ATMWithdrawalResponseV01"
definition="The ATMWithdrawalResponse message is sent by an acquirer or its agent to an ATM in response to the ATMWithdrawalRequest to inform the ATM of the approval or decline of the withdrawal transaction."
registrationStatus="Registered"
messageSet="_lVeMdARsEeWTJNHF-ohSqw"
xmlTag="ATMWdrwlRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_KlPP4Ip1EeS3NqNpgnMh2w"
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="_47_isYnvEeS9F4Qrq_eaVA" />
<messageBuildingBlock
xmi:id="_QcTJ4Ip1EeS3NqNpgnMh2w"
name="ProtectedATMWithdrawalResponse"
definition="Encrypted body of the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PrtctdATMWdrwlRspn"
complexType="_UfeMUWizEeS87LmvcA55sg" />
<messageBuildingBlock
xmi:id="_eGmWsIp1EeS3NqNpgnMh2w"
name="ATMWithdrawalResponse"
definition="Information related to the response of an ATM withdrawal transaction from an ATM manager."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="ATMWdrwlRspn"
complexType="_UC0koIp1EeS3NqNpgnMh2w" />
<messageBuildingBlock
xmi:id="_H-D60IqMEeSRT5rEzcAHEw"
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="002"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.