Iso20022

AcceptorDiagnosticRequestV04

caaa.013.001.04

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
%% AcceptorDiagnosticRequestV04 recursion level 0 with max 0
AcceptorDiagnosticRequestV04 *-- "1..1" Header10 : Header
AcceptorDiagnosticRequestV04 *-- "1..1" AcceptorDiagnosticRequest4 : DiagnosticRequest
AcceptorDiagnosticRequestV04 *-- "1..1" ContentInformationType11 : 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
%% Header10 recursion level 0 with max 1
class Header10{
    MessageFunction MessageFunction4Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header10 *-- "1..1" GenericIdentification53 : InitiatingParty
Header10 *-- "0..1" GenericIdentification53 : RecipientParty
Header10 *-- "0..0" Traceability2 : Traceability
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
    Identification IsoMax35Text
    Type PartyType3Code
    Issuer PartyType4Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
    Identification IsoMax35Text
    Type PartyType3Code
    Issuer PartyType4Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% Traceability2 recursion level 1 with max 1
class Traceability2{
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability2 *-- "1..1" GenericIdentification76 : RelayIdentification

Header10 members

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

AcceptorDiagnosticRequest4 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment42 - 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
%% ContentInformationType11 recursion level 0 with max 1
class ContentInformationType11{
    ContentType ContentType2Code
}
ContentInformationType11 *-- "0..0" 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

ContentInformationType11 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 - Unknown 0..0

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorDiagnosticRequestV04 --|> IOuterRecord : Implements
    AcceptorDiagnosticRequestV04Document --|> IOuterDocument~AcceptorDiagnosticRequestV04~ : Implements
    class IOuterDocument~AcceptorDiagnosticRequestV04~ {
        AcceptorDiagnosticRequestV04 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorDiagnosticRequestV04Document *-- AcceptorDiagnosticRequestV04 : 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.04">
    <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="_DZFgwWpAEeS4VPLpYyQgxQ"
  nextVersions="_fSm6wY3XEeW56qaqQ8B0kQ"
  previousVersion="_nWbGATTaEeO5e9wx3yvd8g"
  name="AcceptorDiagnosticRequestV04"
  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="_DZFgw2pAEeS4VPLpYyQgxQ"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_DZFgxWpAEeS4VPLpYyQgxQ"
    nextVersions="_fSm6xY3XEeW56qaqQ8B0kQ"
    previousVersion="_nWbGAzTaEeO5e9wx3yvd8g"
    name="Header"
    definition="Diagnostic request message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_EXmNsWeeEeSh-d9-KfCEyA" />
  <messageBuildingBlock
    xmi:id="_DZFgx2pAEeS4VPLpYyQgxQ"
    nextVersions="_fSm6x43XEeW56qaqQ8B0kQ"
    previousVersion="_nWbGBTTaEeO5e9wx3yvd8g"
    name="DiagnosticRequest"
    definition="Information related to the diagnostic request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="DgnstcReq"
    complexType="_VliDEWpAEeS4VPLpYyQgxQ" />
  <messageBuildingBlock
    xmi:id="_DZFgyWpAEeS4VPLpYyQgxQ"
    nextVersions="_fSm6yY3XEeW56qaqQ8B0kQ"
    previousVersion="_nWbGBzTaEeO5e9wx3yvd8g"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_cg4dYWkIEeS7zPBpvm732w" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="013"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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