AcceptorDiagnosticRequestV02

caaa.013.001.02

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
%% AcceptorDiagnosticRequestV02 recursion level 0 with max 0
AcceptorDiagnosticRequestV02 *-- "1..1" Header1 : Header
AcceptorDiagnosticRequestV02 *-- "1..1" AcceptorDiagnosticRequest2 : DiagnosticRequest
AcceptorDiagnosticRequestV02 *-- "1..1" ContentInformationType6 : 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
%% 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

DiagnosticRequest building block

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

classDiagram
   direction tb
%% AcceptorDiagnosticRequest2 recursion level 0 with max 1
AcceptorDiagnosticRequest2 *-- "1..1" CardPaymentEnvironment17 : Environment
%% CardPaymentEnvironment17 recursion level 1 with max 1
class CardPaymentEnvironment17{
    AcquirerParametersVersion IsoMax35Text
}
CardPaymentEnvironment17 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment17 *-- "1..1" GenericIdentification32 : POIIdentification
  

AcceptorDiagnosticRequest2 members

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
%% ContentInformationType6 recursion level 0 with max 1
class ContentInformationType6{
    ContentType ContentType1Code
}
ContentInformationType6 *-- "0..0" AuthenticatedData2 : AuthenticatedData
%% AuthenticatedData2 recursion level 1 with max 1
class AuthenticatedData2{
    Version IsoNumber
    MAC IsoMax35Binary
}
AuthenticatedData2 *-- "1..0" IRecipient2Choice : Recipient
AuthenticatedData2 *-- "1..1" AlgorithmIdentification3 : MACAlgorithm
AuthenticatedData2 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
  

ContentInformationType6 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorDiagnosticRequestV02 --|> IOuterRecord : Implements
    AcceptorDiagnosticRequestV02Document --|> IOuterDocument~AcceptorDiagnosticRequestV02~ : Implements
    class IOuterDocument~AcceptorDiagnosticRequestV02~ {
        AcceptorDiagnosticRequestV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AcceptorDiagnosticRequestV02Document *-- AcceptorDiagnosticRequestV02 : 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.02">
    <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="_7YW5gQvgEeK9Xewg3qiFQA"
  nextVersions="_nWbGATTaEeO5e9wx3yvd8g"
  previousVersion="_VxGmFaMVEeCJ6YNENx4h-w_-1426270091"
  name="AcceptorDiagnosticRequestV02"
  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">
  <messageBuildingBlock
    xmi:id="_7YW5gwvgEeK9Xewg3qiFQA"
    nextVersions="_nWbGAzTaEeO5e9wx3yvd8g"
    name="Header"
    definition="Diagnostic request message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_SvV__wEcEeCQm6a_G2yO_w_677025486" />
  <messageBuildingBlock
    xmi:id="_7YW5hwvgEeK9Xewg3qiFQA"
    nextVersions="_nWbGBTTaEeO5e9wx3yvd8g"
    name="DiagnosticRequest"
    definition="Information related to the diagnostic request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="DgnstcReq"
    complexType="_eCalIRz1EeK5OKMB21JFBg" />
  <messageBuildingBlock
    xmi:id="_7YW5iwvgEeK9Xewg3qiFQA"
    nextVersions="_nWbGBzTaEeO5e9wx3yvd8g"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_6DM4sQvFEeKzJ69IWwzB9Q" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="013"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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