AcceptorDiagnosticResponseV01

caaa.014.001.01

Scope The AcceptorDiagnosticResponse message is sent by the acquirer to the card acceptor to confirm the availability of the acquirer. An agent never forwards the message. Usage The AcceptorDiagnosticResponse message is used to:

confirm the availability of the acquirer;
validate the security of the exchanges with the acquirer;
validate the version of the configuration parameters.

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
%% AcceptorDiagnosticResponseV01 recursion level 0 with max 0
AcceptorDiagnosticResponseV01 *-- "1..1" Header1 : Header
AcceptorDiagnosticResponseV01 *-- "1..1" AcceptorDiagnosticResponse1 : DiagnosticResponse
AcceptorDiagnosticResponseV01 *-- "1..1" ContentInformationType3 : SecurityTrailer

Now, we will zero-in one-by-one on each of these building blocks.

Header building block

Diagnostic response message management information. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header1 recursion level 0 with max 1
class Header1{
    MessageFunction MessageFunction1Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header1 *-- "1..1" GenericIdentification32 : InitiatingParty
Header1 *-- "0..1" GenericIdentification32 : RecipientParty
Header1 *-- "0..0" Traceability1 : Traceability
%% GenericIdentification32 recursion level 1 with max 1
class GenericIdentification32{
    Identification IsoMax35Text
    Type PartyType3Code
    Issuer PartyType4Code
    ShortName IsoMax35Text
}
%% GenericIdentification32 recursion level 1 with max 1
class GenericIdentification32{
    Identification IsoMax35Text
    Type PartyType3Code
    Issuer PartyType4Code
    ShortName IsoMax35Text
}
%% Traceability1 recursion level 1 with max 1
class Traceability1{
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability1 *-- "1..1" GenericIdentification31 : RelayIdentification

Header1 members

Member name	Description	Data Type / Multiplicity
MessageFunction	Identifies the type of process related to the message.	MessageFunction1Code - Required 1..1
ProtocolVersion	Version of the acquirer 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.	GenericIdentification32 - Required 1..1
RecipientParty	Unique identification of the partner that is the recipient of the message exchange.	GenericIdentification32 - Optional 0..1
Traceability	Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges.	Traceability1 - Unknown 0..0

DiagnosticResponse building block

Information related to the diagnostic response. Diagnostic response from the acquirer. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AcceptorDiagnosticResponse1 recursion level 0 with max 1
AcceptorDiagnosticResponse1 *-- "1..1" CardPaymentEnvironment8 : Environment
AcceptorDiagnosticResponse1 *-- "0..1" TMSTrigger1 : TMSTrigger
%% CardPaymentEnvironment8 recursion level 1 with max 1
class CardPaymentEnvironment8{
    AcquirerParametersVersion IsoISODateTime
}
CardPaymentEnvironment8 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment8 *-- "1..1" GenericIdentification32 : POIIdentification
%% TMSTrigger1 recursion level 1 with max 1
class TMSTrigger1{
    TMSContactLevel TMSContactLevel1Code
    TMSIdentification IsoMax35Text
    TMSContactDateTime IsoISODateTime
}

AcceptorDiagnosticResponse1 members

Member name	Description	Data Type / Multiplicity
Environment	Environment of the transaction.	CardPaymentEnvironment8 - Required 1..1
TMSTrigger	Instructions for contacting the terminal management host.	TMSTrigger1 - Optional 0..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
%% ContentInformationType3 recursion level 0 with max 1
class ContentInformationType3{
    ContentType ContentType1Code
}
ContentInformationType3 *-- "0..0" AuthenticatedData1 : AuthenticatedData
%% AuthenticatedData1 recursion level 1 with max 1
class AuthenticatedData1{
    Version IsoNumber
    MAC IsoMax35Binary
}
AuthenticatedData1 *-- "1..0" IRecipient1Choice : Recipient
AuthenticatedData1 *-- "1..1" AlgorithmIdentification1 : MACAlgorithm
AuthenticatedData1 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent

ContentInformationType3 members

Member name	Description	Data Type / Multiplicity
ContentType	Type of data protection.	ContentType1Code - Required 1..1
AuthenticatedData	Data protection by a message authentication code (MAC).	AuthenticatedData1 - Unknown 0..0

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the AcceptorDiagnosticResponseV01 implementation follows a specific implementaiton pattern. First of all, AcceptorDiagnosticResponseV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorDiagnosticResponseV01Document implements IOuterDocument. Because AcceptorDiagnosticResponseV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorDiagnosticResponseV01.

classDiagram
    class IOuterRecord
    AcceptorDiagnosticResponseV01 --|> IOuterRecord : Implements
    AcceptorDiagnosticResponseV01Document --|> IOuterDocument~AcceptorDiagnosticResponseV01~ : Implements
    class IOuterDocument~AcceptorDiagnosticResponseV01~ {
        AcceptorDiagnosticResponseV01 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorDiagnosticResponseV01Document *-- AcceptorDiagnosticResponseV01 : 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:caaa.014.001.01">
    <AccptrDgnstcRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <DgnstcRspn>
            <!-- DiagnosticResponse inner content -->
        </DgnstcRspn>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </AccptrDgnstcRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_QI8DtaMVEeCJ6YNENx4h-w_1442328644"
  nextVersions="__eyjYQvgEeK9Xewg3qiFQA"
  name="AcceptorDiagnosticResponseV01"
  definition="Scope&#xD;&#xA;The AcceptorDiagnosticResponse message is sent by the acquirer to the card acceptor to confirm the availability of the acquirer. An agent never forwards the message.&#xD;&#xA;Usage&#xD;&#xA;The AcceptorDiagnosticResponse message is used to:&#xD;&#xA;- confirm the availability of the acquirer;&#xD;&#xA;- validate the security of the exchanges with the acquirer;&#xD;&#xA;- validate the version of the configuration parameters."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AccptrDgnstcRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_QI8DtqMVEeCJ6YNENx4h-w_1563091658"
    name="Header"
    definition="Diagnostic response message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_SvV__wEcEeCQm6a_G2yO_w_677025486" />
  <messageBuildingBlock
    xmi:id="_QI8Dt6MVEeCJ6YNENx4h-w_-853433637"
    name="DiagnosticResponse"
    definition="Information related to the diagnostic response."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="DgnstcRspn"
    complexType="_Svo64wEcEeCQm6a_G2yO_w_-1117084732" />
  <messageBuildingBlock
    xmi:id="_QI8DuKMVEeCJ6YNENx4h-w_37041844"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_SvV__AEcEeCQm6a_G2yO_w_153583816" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="014"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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