ATMInquiryResponseV01

catp.007.001.01

The ATMInquiryResponse message is sent by an ATM manager or its agent to the ATM to provide the information and the outcome of the verifications requested in the ATMInquiryRequest.

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
%% ATMInquiryResponseV01 recursion level 0 with max 0
ATMInquiryResponseV01 *-- "1..1" Header20 : Header
ATMInquiryResponseV01 *-- "0..1" ContentInformationType10 : ProtectedATMInquiryResponse
ATMInquiryResponseV01 *-- "0..1" ATMInquiryResponse1 : ATMInquiryResponse
ATMInquiryResponseV01 *-- "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

ProtectedATMInquiryResponse 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

ATMInquiryResponse building block

Information related to the response of an ATM inquiry from an ATM manager. Information related to the response of an ATM inquiry from an ATM manager. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ATMInquiryResponse1 recursion level 0 with max 1
ATMInquiryResponse1 *-- "1..1" ATMEnvironment5 : Environment
ATMInquiryResponse1 *-- "1..1" ATMContext6 : Context
ATMInquiryResponse1 *-- "1..1" ATMTransaction7 : Transaction
%% ATMEnvironment5 recursion level 1 with max 1
ATMEnvironment5 *-- "1..1" AutomatedTellerMachine2 : ATM
ATMEnvironment5 *-- "1..1" ATMCustomer2 : Customer
ATMEnvironment5 *-- "0..1" ContentInformationType10 : ProtectedCardData
ATMEnvironment5 *-- "0..1" PlainCardData14 : PlainCardData
%% ATMContext6 recursion level 1 with max 1
class ATMContext6{
    SessionReference IsoMax35Text
}
ATMContext6 *-- "1..1" ATMService6 : Service
%% ATMTransaction7 recursion level 1 with max 1
class ATMTransaction7{
    ICCRelatedData IsoMax10000Binary
}
ATMTransaction7 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
ATMTransaction7 *-- "1..1" ResponseType3 : TransactionResponse
ATMTransaction7 *-- "0..0" Action5 : Action
ATMTransaction7 *-- "0..1" ATMCustomerProfile3 : CustomerServiceProfile
ATMTransaction7 *-- "0..1" CurrencyConversion3 : CurrencyConversion
ATMTransaction7 *-- "0..0" CardAccount6 : AccountInformation
ATMTransaction7 *-- "0..0" ATMAccountStatement1 : AccountStatementData
ATMTransaction7 *-- "0..1" CurrencyConversion5 : CurrencyExchange
ATMTransaction7 *-- "0..0" ATMCommand1 : Command

ATMInquiryResponse1 members

Member name	Description	Data Type / Multiplicity
Environment	Environment of the transaction.	ATMEnvironment5 - Required 1..1
Context	Context in which the inquiry is performed.	ATMContext6 - Required 1..1
Transaction	Inquiry information for the transaction.	ATMTransaction7 - 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 ATMInquiryResponseV01 implementation follows a specific implementaiton pattern. First of all, ATMInquiryResponseV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ATMInquiryResponseV01Document implements IOuterDocument. Because ATMInquiryResponseV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ATMInquiryResponseV01.

classDiagram
    class IOuterRecord
    ATMInquiryResponseV01 --|> IOuterRecord : Implements
    ATMInquiryResponseV01Document --|> IOuterDocument~ATMInquiryResponseV01~ : Implements
    class IOuterDocument~ATMInquiryResponseV01~ {
        ATMInquiryResponseV01 Message
     }

Document wrapper for serialization

The only real purpose ATMInquiryResponseV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:catp.007.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ATMInquiryResponseV01.ToDocument() method. The returned ATMInquiryResponseV01Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    ATMInquiryResponseV01Document *-- ATMInquiryResponseV01 : 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.007.001.01">
    <ATMNqryRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <PrtctdATMNqryRspn>
            <!-- ProtectedATMInquiryResponse inner content -->
        </PrtctdATMNqryRspn>
        <ATMNqryRspn>
            <!-- ATMInquiryResponse inner content -->
        </ATMNqryRspn>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </ATMNqryRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_ni6eUIqwEeSIDtZ76p6McQ"
  nextVersions="_P04uca4WEeW_TaP-ygI0SQ"
  name="ATMInquiryResponseV01"
  definition="The ATMInquiryResponse message is sent by an ATM manager or its agent to the ATM to provide the information and the outcome of the verifications requested in the ATMInquiryRequest."
  registrationStatus="Registered"
  messageSet="_lVeMdARsEeWTJNHF-ohSqw"
  xmlTag="ATMNqryRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_wJq4wIqwEeSIDtZ76p6McQ"
    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="_9db04IqwEeSIDtZ76p6McQ"
    name="ProtectedATMInquiryResponse"
    definition="Encrypted body of the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PrtctdATMNqryRspn"
    complexType="_UfeMUWizEeS87LmvcA55sg" />
  <messageBuildingBlock
    xmi:id="_GOZUMIqxEeSIDtZ76p6McQ"
    name="ATMInquiryResponse"
    definition="Information related to the response of an ATM inquiry from an ATM manager."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="ATMNqryRspn"
    complexType="__fAEAIqwEeSIDtZ76p6McQ" />
  <messageBuildingBlock
    xmi:id="_MBxBAIqxEeSIDtZ76p6McQ"
    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="007"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.