Iso20022

AcceptorDiagnosticRequestV07

caaa.013.001.07

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
%% AcceptorDiagnosticRequestV07 recursion level 0 with max 0
AcceptorDiagnosticRequestV07 *-- "1..1" Header35 : Header
AcceptorDiagnosticRequestV07 *-- "1..1" AcceptorDiagnosticRequest7 : DiagnosticRequest
AcceptorDiagnosticRequestV07 *-- "0..1" ContentInformationType16 : 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
%% Header35 recursion level 0 with max 1
class Header35{
    MessageFunction MessageFunction14Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    CreationDateTime IsoISODateTime
}
Header35 *-- "1..1" GenericIdentification53 : InitiatingParty
Header35 *-- "0..1" GenericIdentification94 : RecipientParty
Header35 *-- "0..0" Traceability5 : Traceability
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
    Identification IsoMax35Text
    Type PartyType3Code
    Issuer PartyType4Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification94 recursion level 1 with max 1
class GenericIdentification94{
    Identification IsoMax35Text
    Type PartyType3Code
    Issuer PartyType4Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
GenericIdentification94 *-- "0..1" NetworkParameters5 : RemoteAccess
%% Traceability5 recursion level 1 with max 1
class Traceability5{
    ProtocolName IsoMax35Text
    ProtocolVersion IsoMax6Text
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability5 *-- "1..1" GenericIdentification76 : RelayIdentification

Header35 members

Member name Description Data Type / Multiplicity
MessageFunction Identifies the type of process related to the message. MessageFunction14Code - 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
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. GenericIdentification53 - Required 1..1
RecipientParty Unique identification of the partner that is the recipient of the message exchange. GenericIdentification94 - Optional 0..1
Traceability Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. Traceability5 - 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
%% AcceptorDiagnosticRequest7 recursion level 0 with max 1
AcceptorDiagnosticRequest7 *-- "1..1" CardPaymentEnvironment71 : Environment
%% CardPaymentEnvironment71 recursion level 1 with max 1
class CardPaymentEnvironment71{
    AcquirerAvailabilityRequested IsoTrueFalseIndicator
    AcquirerAvailable IsoTrueFalseIndicator
}
CardPaymentEnvironment71 *-- "1..1" Acquirer4 : Acquirer
CardPaymentEnvironment71 *-- "0..1" GenericIdentification53 : MerchantIdentification
CardPaymentEnvironment71 *-- "0..1" GenericIdentification32 : POIIdentification
CardPaymentEnvironment71 *-- "0..0" PointOfInteractionComponent8 : POIComponent

AcceptorDiagnosticRequest7 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment71 - 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
%% ContentInformationType16 recursion level 0 with max 1
class ContentInformationType16{
    ContentType ContentType2Code
}
ContentInformationType16 *-- "1..1" AuthenticatedData5 : AuthenticatedData
%% AuthenticatedData5 recursion level 1 with max 1
class AuthenticatedData5{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData5 *-- "1..0" IRecipient6Choice : Recipient
AuthenticatedData5 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData5 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent

ContentInformationType16 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). AuthenticatedData5 - Required 1..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorDiagnosticRequestV07 --|> IOuterRecord : Implements
    AcceptorDiagnosticRequestV07Document --|> IOuterDocument~AcceptorDiagnosticRequestV07~ : Implements
    class IOuterDocument~AcceptorDiagnosticRequestV07~ {
        AcceptorDiagnosticRequestV07 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorDiagnosticRequestV07Document *-- AcceptorDiagnosticRequestV07 : 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.07">
    <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="_TT2V8ds5Eee9e6xduATmQg"
  nextVersions="_DS7ioQukEeqw5uEXxQ9H4g"
  previousVersion="_OjCqsbChEeapjPTKZHuM2w"
  name="AcceptorDiagnosticRequestV07"
  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="_TT29Ads5Eee9e6xduATmQg"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_TT29A9s5Eee9e6xduATmQg"
    nextVersions="_DS7ipQukEeqw5uEXxQ9H4g"
    previousVersion="_OjCqtbChEeapjPTKZHuM2w"
    name="Header"
    definition="Diagnostic request message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_igU6wdnGEeeN3v2fup_Shw" />
  <messageBuildingBlock
    xmi:id="_TT29Bds5Eee9e6xduATmQg"
    nextVersions="_DS7ipwukEeqw5uEXxQ9H4g"
    previousVersion="_OjCqt7ChEeapjPTKZHuM2w"
    name="DiagnosticRequest"
    definition="Information related to the diagnostic request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="DgnstcReq"
    complexType="_WRa6cdwiEeeKpa-yxjuKzQ" />
  <messageBuildingBlock
    xmi:id="_TT29B9s5Eee9e6xduATmQg"
    nextVersions="_DS7iqQukEeqw5uEXxQ9H4g"
    previousVersion="_OjCqubChEeapjPTKZHuM2w"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_Wb7MEds3Eee9e6xduATmQg" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="013"
    flavour="001"
    version="07" />
</messageDefinition>

ISO Building Blocks

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