caam.004.001.01
The ATMKeyDownloadResponse message is sent from an acquirer to an ATM in response to an ATMKeyDownloadRequest message, to download of one or several cryptographic keys.
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
%% ATMKeyDownloadResponseV01 recursion level 0 with max 0
ATMKeyDownloadResponseV01 *-- "1..1" Header20 : Header
ATMKeyDownloadResponseV01 *-- "0..1" ContentInformationType10 : ProtectedATMKeyDownloadResponse
ATMKeyDownloadResponseV01 *-- "0..1" ATMKeyDownloadResponse1 : ATMKeyDownloadResponse
ATMKeyDownloadResponseV01 *-- "0..1" ContentInformationType13 : 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 |
ProtectedATMKeyDownloadResponse 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 |
ATMKeyDownloadResponse building block
Information related to the response of an ATM key download from an ATM manager. Information related to the response of an ATM key download from an ATM manager. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ATMKeyDownloadResponse1 recursion level 0 with max 1
class ATMKeyDownloadResponse1{
ATMChallenge IsoMax140Binary
}
ATMKeyDownloadResponse1 *-- "1..1" ATMEnvironment7 : Environment
ATMKeyDownloadResponse1 *-- "1..1" ATMSecurityContext2 : ATMSecurityContext
ATMKeyDownloadResponse1 *-- "1..1" SecurityParameters5 : HostSecurityParameters
ATMKeyDownloadResponse1 *-- "0..0" ATMCommand1 : Command
%% ATMEnvironment7 recursion level 1 with max 1
ATMEnvironment7 *-- "0..1" Acquirer7 : Acquirer
ATMEnvironment7 *-- "0..1" Acquirer8 : ATMManager
ATMEnvironment7 *-- "0..1" TerminalHosting1 : HostingEntity
ATMEnvironment7 *-- "1..1" AutomatedTellerMachine3 : ATM
%% ATMSecurityContext2 recursion level 1 with max 1
class ATMSecurityContext2{
CurrentSecurityScheme ATMSecurityScheme1Code
}
ATMSecurityContext2 *-- "0..1" ATMEquipment3 : DeviceProperty
ATMSecurityContext2 *-- "0..1" ATMSecurityConfiguration1 : CurrentConfiguration
%% SecurityParameters5 recursion level 1 with max 1
class SecurityParameters5{
HostChallenge IsoMax140Binary
}
SecurityParameters5 *-- "0..0" CryptographicKey8 : Key
SecurityParameters5 *-- "0..1" ContentInformationType14 : DigitalSignature
%% ATMCommand1 recursion level 1 with max 1
class ATMCommand1{
Type ATMCommand1Code
Urgency TMSContactLevel2Code
DateTime IsoISODateTime
}
ATMCommand1 *-- "0..1" ATMCommandIdentification1 : CommandIdentification
ATMCommand1 *-- "0..1" IATMCommandParameters1Choice : CommandParameters
ATMKeyDownloadResponse1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the key download. | ATMEnvironment7 - Required 1..1 |
| ATMSecurityContext | Context of the ATM for the key download. | ATMSecurityContext2 - Required 1..1 |
| ATMChallenge | Random value from the ATM provided during a previous exchange. | IsoMax140Binary - Optional 0..1 |
| HostSecurityParameters | Security parameters of the host downloading the key. | SecurityParameters5 - Required 1..1 |
| Command | Maintenance command to perform on the ATM. | ATMCommand1 - Unknown 0..0 |
SecurityTrailer building block
Trailer of the message containing a MAC or a digital signature. General cryptographic message syntax (CMS) containing data. protected by a MAC or a digital signature. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ContentInformationType13 recursion level 0 with max 1
class ContentInformationType13{
ContentType ContentType2Code
}
ContentInformationType13 *-- "0..1" AuthenticatedData4 : AuthenticatedData
ContentInformationType13 *-- "0..1" SignedData4 : SignedData
%% 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
%% SignedData4 recursion level 1 with max 1
class SignedData4{
Version IsoNumber
Certificate IsoMax5000Binary
}
SignedData4 *-- "1..0" AlgorithmIdentification16 : DigestAlgorithm
SignedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
SignedData4 *-- "1..0" Signer3 : Signer
ContentInformationType13 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 - Optional 0..1 |
| SignedData | Data protected by a digital signatures. | SignedData4 - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the ATMKeyDownloadResponseV01 implementation follows a specific implementaiton pattern. First of all, ATMKeyDownloadResponseV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ATMKeyDownloadResponseV01Document implements IOuterDocument. Because ATMKeyDownloadResponseV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ATMKeyDownloadResponseV01.
classDiagram
class IOuterRecord
ATMKeyDownloadResponseV01 --|> IOuterRecord : Implements
ATMKeyDownloadResponseV01Document --|> IOuterDocument~ATMKeyDownloadResponseV01~ : Implements
class IOuterDocument~ATMKeyDownloadResponseV01~ {
ATMKeyDownloadResponseV01 Message
}
Document wrapper for serialization
The only real purpose ATMKeyDownloadResponseV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caam.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 ATMKeyDownloadResponseV01.ToDocument() method. The returned ATMKeyDownloadResponseV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ATMKeyDownloadResponseV01Document *-- ATMKeyDownloadResponseV01 : 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:caam.004.001.01">
<ATMKeyDwnldRspn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<PrtctdATMKeyDwnldRspn>
<!-- ProtectedATMKeyDownloadResponse inner content -->
</PrtctdATMKeyDwnldRspn>
<ATMKeyDwnldRspn>
<!-- ATMKeyDownloadResponse inner content -->
</ATMKeyDwnldRspn>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</ATMKeyDwnldRspn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_doLoYItREeST3ocKVc8_qA"
nextVersions="__AA4sa45EeWRfYPBaeOY8w"
name="ATMKeyDownloadResponseV01"
definition="The ATMKeyDownloadResponse message is sent from an acquirer to an ATM in response to an ATMKeyDownloadRequest message, to download of one or several cryptographic keys."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="ATMKeyDwnldRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_k16aYItREeST3ocKVc8_qA"
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="_uXuu4ItREeST3ocKVc8_qA"
name="ProtectedATMKeyDownloadResponse"
definition="Encrypted body of the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PrtctdATMKeyDwnldRspn"
complexType="_UfeMUWizEeS87LmvcA55sg" />
<messageBuildingBlock
xmi:id="_561lsItREeST3ocKVc8_qA"
name="ATMKeyDownloadResponse"
definition="Information related to the response of an ATM key download from an ATM manager."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="ATMKeyDwnldRspn"
complexType="_vxSi0ItREeST3ocKVc8_qA" />
<messageBuildingBlock
xmi:id="_-i7yMItREeST3ocKVc8_qA"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC or a digital signature."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_R_tFoYreEeSvuOJS0mmL0g" />
<messageDefinitionIdentifier
businessArea="caam"
messageFunctionality="004"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.