catp.013.001.01
The ATMDepositResponse message is sent by an ATM manager or its agent to inform the ATM of the approval or decline of the deposit 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
%% ATMDepositResponseV01 recursion level 0 with max 0
ATMDepositResponseV01 *-- "1..1" Header31 : Header
ATMDepositResponseV01 *-- "0..1" ContentInformationType10 : ProtectedATMDepositResponse
ATMDepositResponseV01 *-- "0..1" ATMDepositResponse1 : ATMDepositResponse
ATMDepositResponseV01 *-- "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
%% Header31 recursion level 0 with max 1
class Header31{
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoMax3NumericText
CreationDateTime IsoISODateTime
InitiatingParty IsoMax35Text
RecipientParty IsoMax35Text
ProcessState IsoMax35Text
}
Header31 *-- "1..1" ATMMessageFunction2 : MessageFunction
Header31 *-- "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
Header31 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 |
| 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 |
ProtectedATMDepositResponse 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 |
ATMDepositResponse building block
Response to a deposit request. Response to a deposit request. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ATMDepositResponse1 recursion level 0 with max 1
ATMDepositResponse1 *-- "1..1" ATMEnvironment12 : Environment
ATMDepositResponse1 *-- "1..1" ATMContext11 : Context
ATMDepositResponse1 *-- "1..1" ATMTransaction16 : Transaction
%% ATMEnvironment12 recursion level 1 with max 1
ATMEnvironment12 *-- "0..1" Acquirer7 : Acquirer
ATMEnvironment12 *-- "0..1" Acquirer8 : ATMManager
ATMEnvironment12 *-- "0..1" TerminalHosting1 : HostingEntity
ATMEnvironment12 *-- "1..1" AutomatedTellerMachine2 : ATM
ATMEnvironment12 *-- "1..1" ATMCustomer5 : Customer
ATMEnvironment12 *-- "0..1" ContentInformationType10 : ProtectedCardData
ATMEnvironment12 *-- "0..1" PlainCardData19 : PlainCardData
%% ATMContext11 recursion level 1 with max 1
class ATMContext11{
SessionReference IsoMax35Text
}
ATMContext11 *-- "0..1" ATMService12 : Service
%% ATMTransaction16 recursion level 1 with max 1
class ATMTransaction16{
ReconciliationIdentification IsoMax35Text
CompletionRequired IsoTrueFalseIndicator
TotalRequestedAmount IsoImpliedCurrencyAndAmount
ICCRelatedData IsoMax10000Binary
}
ATMTransaction16 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
ATMTransaction16 *-- "0..1" CardAccount10 : AccountData
ATMTransaction16 *-- "0..1" ContentInformationType10 : ProtectedAccountData
ATMTransaction16 *-- "1..1" AmountAndCurrency1 : TotalAuthorisedAmount
ATMTransaction16 *-- "0..0" DetailedAmount16 : DetailedRequestedAmount
ATMTransaction16 *-- "0..0" DetailedAmount13 : AdditionalCharge
ATMTransaction16 *-- "0..1" AuthorisationResult13 : AuthorisationResult
ATMTransaction16 *-- "0..0" ATMCommand7 : Command
ATMDepositResponse1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the deposit transaction. | ATMEnvironment12 - Required 1..1 |
| Context | Context in which the transaction is performed. | ATMContext11 - Required 1..1 |
| Transaction | Response to the deposit request. | ATMTransaction16 - 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 ATMDepositResponseV01 implementation follows a specific implementaiton pattern. First of all, ATMDepositResponseV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ATMDepositResponseV01Document implements IOuterDocument. Because ATMDepositResponseV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ATMDepositResponseV01.
classDiagram
class IOuterRecord
ATMDepositResponseV01 --|> IOuterRecord : Implements
ATMDepositResponseV01Document --|> IOuterDocument~ATMDepositResponseV01~ : Implements
class IOuterDocument~ATMDepositResponseV01~ {
ATMDepositResponseV01 Message
}
Document wrapper for serialization
The only real purpose ATMDepositResponseV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:catp.013.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ATMDepositResponseV01.ToDocument() method. The returned ATMDepositResponseV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ATMDepositResponseV01Document *-- ATMDepositResponseV01 : 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.013.001.01">
<ATMDpstRspn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<PrtctdATMDpstRspn>
<!-- ProtectedATMDepositResponse inner content -->
</PrtctdATMDpstRspn>
<ATMDpstRspn>
<!-- ATMDepositResponse inner content -->
</ATMDpstRspn>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</ATMDpstRspn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_sk60AK4FEeWL1uap3dNhCQ"
name="ATMDepositResponseV01"
definition="The ATMDepositResponse message is sent by an ATM manager or its agent to inform the ATM of the approval or decline of the deposit transaction."
registrationStatus="Registered"
messageSet="_wx2hAK1hEeWMg5rOByfExw"
xmlTag="ATMDpstRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_0hWfEK4FEeWL1uap3dNhCQ"
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="_eMl4Qa1wEeWMg5rOByfExw" />
<messageBuildingBlock
xmi:id="_4cmzsK4FEeWL1uap3dNhCQ"
name="ProtectedATMDepositResponse"
definition="Encrypted body of the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PrtctdATMDpstRspn"
complexType="_UfeMUWizEeS87LmvcA55sg" />
<messageBuildingBlock
xmi:id="_69usoK4FEeWL1uap3dNhCQ"
name="ATMDepositResponse"
definition="Response to a deposit request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="ATMDpstRspn"
complexType="_Eg99cK4GEeWL1uap3dNhCQ" />
<messageBuildingBlock
xmi:id="__TucgK4FEeWL1uap3dNhCQ"
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="013"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.