Iso20022

AcceptorDiagnosticRequestV08

caaa.013.001.08

The AcceptorDiagnosticRequest message is sent by an acceptor (or its agent) to the acquirer (or its agent), to check the end-to-end communication, to test the availability of this acquirer, or to validate the security environment.

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
%% AcceptorDiagnosticRequestV08 recursion level 0 with max 0
AcceptorDiagnosticRequestV08 *-- "1..1" Header58 : Header
AcceptorDiagnosticRequestV08 *-- "1..1" AcceptorDiagnosticRequest8 : DiagnosticRequest
AcceptorDiagnosticRequestV08 *-- "0..1" ContentInformationType24 : SecurityTrailer

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

Header building block

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

classDiagram
   direction tb
%% Header58 recursion level 0 with max 1
class Header58{
    MessageFunction MessageFunction41Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header58 *-- "1..1" GenericIdentification176 : InitiatingParty
Header58 *-- "0..1" GenericIdentification177 : RecipientParty
Header58 *-- "0..0" Traceability8 : Traceability
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification177 recursion level 1 with max 1
class GenericIdentification177{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
GenericIdentification177 *-- "0..1" NetworkParameters7 : RemoteAccess
GenericIdentification177 *-- "0..1" Geolocation1 : Geolocation
%% Traceability8 recursion level 1 with max 1
class Traceability8{
    ProtocolName IsoMax35Text
    ProtocolVersion IsoMax6Text
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability8 *-- "1..1" GenericIdentification177 : RelayIdentification

Header58 members

Member name Description Data Type / Multiplicity
MessageFunction Identifies the type of process related to the message. MessageFunction41Code - Required 1..1
ProtocolVersion Version of the acquirer protocol specifications. IsoMax6Text - Required 1..1
ExchangeIdentification Unique identification of an exchange occurrence. IsoNumber - Required 1..1
ReTransmissionCounter Number of retransmissions of the message. IsoMax3NumericText - Optional 0..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. GenericIdentification176 - Required 1..1
RecipientParty Unique identification of the partner that is the recipient of the message exchange. GenericIdentification177 - Optional 0..1
Traceability Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. Traceability8 - Unknown 0..0

DiagnosticRequest building block

Information related to the diagnostic request. Diagnostic request from an acceptor. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AcceptorDiagnosticRequest8 recursion level 0 with max 1
class AcceptorDiagnosticRequest8{
    AcquirerAvailabilityRequested IsoTrueFalseIndicator
}
AcceptorDiagnosticRequest8 *-- "1..1" CardPaymentEnvironment74 : Environment
%% CardPaymentEnvironment74 recursion level 1 with max 1
CardPaymentEnvironment74 *-- "0..1" Acquirer10 : Acquirer
CardPaymentEnvironment74 *-- "0..1" Organisation32 : Merchant
CardPaymentEnvironment74 *-- "0..1" PointOfInteraction10 : POI
CardPaymentEnvironment74 *-- "0..1" PaymentCard30 : Card
CardPaymentEnvironment74 *-- "0..1" CustomerDevice1 : CustomerDevice
CardPaymentEnvironment74 *-- "0..1" CustomerDevice1 : Wallet
CardPaymentEnvironment74 *-- "0..1" CardPaymentToken5 : PaymentToken
CardPaymentEnvironment74 *-- "0..1" Cardholder16 : Cardholder
CardPaymentEnvironment74 *-- "0..1" ContentInformationType22 : ProtectedCardholderData

AcceptorDiagnosticRequest8 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment74 - Required 1..1
AcquirerAvailabilityRequested Indicates if the availability of the acquirer must be tested. IsoTrueFalseIndicator - 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
%% ContentInformationType24 recursion level 0 with max 1
class ContentInformationType24{
    ContentType ContentType2Code
}
ContentInformationType24 *-- "1..1" AuthenticatedData6 : AuthenticatedData
%% AuthenticatedData6 recursion level 1 with max 1
class AuthenticatedData6{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData6 *-- "1..0" IRecipient8Choice : Recipient
AuthenticatedData6 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData6 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent

ContentInformationType24 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). AuthenticatedData6 - Required 1..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorDiagnosticRequestV08 --|> IOuterRecord : Implements
    AcceptorDiagnosticRequestV08Document --|> IOuterDocument~AcceptorDiagnosticRequestV08~ : Implements
    class IOuterDocument~AcceptorDiagnosticRequestV08~ {
        AcceptorDiagnosticRequestV08 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorDiagnosticRequestV08Document *-- AcceptorDiagnosticRequestV08 : 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.013.001.08">
    <AccptrDgnstcReq>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <DgnstcReq>
            <!-- DiagnosticRequest inner content -->
        </DgnstcReq>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </AccptrDgnstcReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_DS7ioQukEeqw5uEXxQ9H4g"
  nextVersions="_8OPcQS5IEeunNvJlR_vCbg"
  previousVersion="_TT2V8ds5Eee9e6xduATmQg"
  name="AcceptorDiagnosticRequestV08"
  definition="The AcceptorDiagnosticRequest message is sent by an acceptor (or its agent) to the acquirer (or its agent), to check the end-to-end communication, to test the availability of this acquirer, or to validate the security environment."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AccptrDgnstcReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_DS7iowukEeqw5uEXxQ9H4g"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_DS7ipQukEeqw5uEXxQ9H4g"
    nextVersions="_8OPcRS5IEeunNvJlR_vCbg"
    previousVersion="_TT29A9s5Eee9e6xduATmQg"
    name="Header"
    definition="Diagnostic request message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_-_R68QuJEeqYM5yH99IYQw" />
  <messageBuildingBlock
    xmi:id="_DS7ipwukEeqw5uEXxQ9H4g"
    nextVersions="_8OPcRy5IEeunNvJlR_vCbg"
    previousVersion="_TT29Bds5Eee9e6xduATmQg"
    name="DiagnosticRequest"
    definition="Information related to the diagnostic request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="DgnstcReq"
    complexType="_kRo00QujEeqw5uEXxQ9H4g" />
  <messageBuildingBlock
    xmi:id="_DS7iqQukEeqw5uEXxQ9H4g"
    nextVersions="_8OPcSS5IEeunNvJlR_vCbg"
    previousVersion="_TT29B9s5Eee9e6xduATmQg"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_GpvT8QuEEeqYM5yH99IYQw" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="013"
    flavour="001"
    version="08" />
</messageDefinition>

ISO Building Blocks

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