Iso20022

AcceptorDiagnosticRequestV05

caaa.013.001.05

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
%% AcceptorDiagnosticRequestV05 recursion level 0 with max 0
AcceptorDiagnosticRequestV05 *-- "1..1" Header30 : Header
AcceptorDiagnosticRequestV05 *-- "1..1" AcceptorDiagnosticRequest5 : DiagnosticRequest
AcceptorDiagnosticRequestV05 *-- "0..1" ContentInformationType15 : 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
%% Header30 recursion level 0 with max 1
class Header30{
    MessageFunction MessageFunction10Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    CreationDateTime IsoISODateTime
}
Header30 *-- "1..1" GenericIdentification53 : InitiatingParty
Header30 *-- "0..1" GenericIdentification94 : RecipientParty
Header30 *-- "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

Header30 members

Member name Description Data Type / Multiplicity
MessageFunction Identifies the type of process related to the message. MessageFunction10Code - 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
%% AcceptorDiagnosticRequest5 recursion level 0 with max 1
AcceptorDiagnosticRequest5 *-- "1..1" CardPaymentEnvironment55 : Environment
%% CardPaymentEnvironment55 recursion level 1 with max 1
class CardPaymentEnvironment55{
    AcquirerAvailabilityRequested IsoTrueFalseIndicator
}
CardPaymentEnvironment55 *-- "1..1" Acquirer4 : Acquirer
CardPaymentEnvironment55 *-- "0..1" GenericIdentification53 : MerchantIdentification
CardPaymentEnvironment55 *-- "0..1" GenericIdentification32 : POIIdentification
CardPaymentEnvironment55 *-- "0..0" PointOfInteractionComponent6 : POIComponent

AcceptorDiagnosticRequest5 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment55 - 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 AcceptorDiagnosticRequestV05 implementation follows a specific implementaiton pattern. First of all, AcceptorDiagnosticRequestV05 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorDiagnosticRequestV05Document implements IOuterDocument. Because AcceptorDiagnosticRequestV05 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorDiagnosticRequestV05.

classDiagram
    class IOuterRecord
    AcceptorDiagnosticRequestV05 --|> IOuterRecord : Implements
    AcceptorDiagnosticRequestV05Document --|> IOuterDocument~AcceptorDiagnosticRequestV05~ : Implements
    class IOuterDocument~AcceptorDiagnosticRequestV05~ {
        AcceptorDiagnosticRequestV05 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorDiagnosticRequestV05Document *-- AcceptorDiagnosticRequestV05 : 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.05">
    <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="_fSm6wY3XEeW56qaqQ8B0kQ"
  nextVersions="_OjCqsbChEeapjPTKZHuM2w"
  previousVersion="_DZFgwWpAEeS4VPLpYyQgxQ"
  name="AcceptorDiagnosticRequestV05"
  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="_fSm6w43XEeW56qaqQ8B0kQ"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_fSm6xY3XEeW56qaqQ8B0kQ"
    nextVersions="_OjCqtbChEeapjPTKZHuM2w"
    previousVersion="_DZFgxWpAEeS4VPLpYyQgxQ"
    name="Header"
    definition="Diagnostic request message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_IWFRgY0PEeWRYffwL7E13A" />
  <messageBuildingBlock
    xmi:id="_fSm6x43XEeW56qaqQ8B0kQ"
    nextVersions="_OjCqt7ChEeapjPTKZHuM2w"
    previousVersion="_DZFgx2pAEeS4VPLpYyQgxQ"
    name="DiagnosticRequest"
    definition="Information related to the diagnostic request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="DgnstcReq"
    complexType="_sW0_AY3XEeW56qaqQ8B0kQ" />
  <messageBuildingBlock
    xmi:id="_fSm6yY3XEeW56qaqQ8B0kQ"
    nextVersions="_OjCqubChEeapjPTKZHuM2w"
    previousVersion="_DZFgyWpAEeS4VPLpYyQgxQ"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_uSOuUCrHEeWRf8RNsvC5fQ" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="013"
    flavour="001"
    version="05" />
</messageDefinition>

ISO Building Blocks

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