AcceptorDiagnosticResponseV03

caaa.014.001.03

The AcceptorDiagnosticResponse message is sent by the acquirer (or its agent) to provide to the acceptor the result of the diagnostic request.

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
%% AcceptorDiagnosticResponseV03 recursion level 0 with max 0
AcceptorDiagnosticResponseV03 *-- "1..1" Header7 : Header
AcceptorDiagnosticResponseV03 *-- "1..1" AcceptorDiagnosticResponse3 : DiagnosticResponse
AcceptorDiagnosticResponseV03 *-- "1..1" ContentInformationType8 : SecurityTrailer
  

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

Header building block

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

classDiagram
   direction tb
%% Header7 recursion level 0 with max 1
class Header7{
    MessageFunction MessageFunction4Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header7 *-- "1..1" GenericIdentification32 : InitiatingParty
Header7 *-- "0..1" GenericIdentification32 : RecipientParty
Header7 *-- "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
  

Header7 members

DiagnosticResponse building block

Information related to the diagnostic response. Diagnostic response from the acquirer. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AcceptorDiagnosticResponse3 recursion level 0 with max 1
AcceptorDiagnosticResponse3 *-- "1..1" CardPaymentEnvironment31 : Environment
AcceptorDiagnosticResponse3 *-- "0..1" TMSTrigger1 : TMSTrigger
%% CardPaymentEnvironment31 recursion level 1 with max 1
class CardPaymentEnvironment31{
    AcquirerAvailable IsoTrueFalseIndicator
}
CardPaymentEnvironment31 *-- "1..1" Acquirer2 : Acquirer
CardPaymentEnvironment31 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment31 *-- "0..1" GenericIdentification32 : POIIdentification
%% TMSTrigger1 recursion level 1 with max 1
class TMSTrigger1{
    TMSContactLevel TMSContactLevel1Code
    TMSIdentification IsoMax35Text
    TMSContactDateTime IsoISODateTime
}
  

AcceptorDiagnosticResponse3 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
%% ContentInformationType8 recursion level 0 with max 1
class ContentInformationType8{
    ContentType ContentType1Code
}
ContentInformationType8 *-- "0..0" AuthenticatedData3 : AuthenticatedData
%% AuthenticatedData3 recursion level 1 with max 1
class AuthenticatedData3{
    Version IsoNumber
    MAC IsoMax35Binary
}
AuthenticatedData3 *-- "1..0" IRecipient3Choice : Recipient
AuthenticatedData3 *-- "1..1" AlgorithmIdentification10 : MACAlgorithm
AuthenticatedData3 *-- "1..1" EncapsulatedContent2 : EncapsulatedContent
  

ContentInformationType8 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorDiagnosticResponseV03 --|> IOuterRecord : Implements
    AcceptorDiagnosticResponseV03Document --|> IOuterDocument~AcceptorDiagnosticResponseV03~ : Implements
    class IOuterDocument~AcceptorDiagnosticResponseV03~ {
        AcceptorDiagnosticResponseV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AcceptorDiagnosticResponseV03Document *-- AcceptorDiagnosticResponseV03 : 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.014.001.03">
    <AccptrDgnstcRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <DgnstcRspn>
            <!-- DiagnosticResponse inner content -->
        </DgnstcRspn>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </AccptrDgnstcRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_Rt4lYTTcEeO5e9wx3yvd8g"
  nextVersions="_hyw_gWpBEeS4VPLpYyQgxQ"
  previousVersion="__eyjYQvgEeK9Xewg3qiFQA"
  name="AcceptorDiagnosticResponseV03"
  definition="The AcceptorDiagnosticResponse message is sent by the acquirer (or its agent) to provide to the acceptor the result of the diagnostic request."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AccptrDgnstcRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_R5MdgDTcEeO5e9wx3yvd8g"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_Rt4lYzTcEeO5e9wx3yvd8g"
    nextVersions="_hyw_hWpBEeS4VPLpYyQgxQ"
    previousVersion="__eyjYwvgEeK9Xewg3qiFQA"
    name="Header"
    definition="Diagnostic response message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_UNSh8S9IEeOlZIh7PImd0A" />
  <messageBuildingBlock
    xmi:id="_Rt4lZTTcEeO5e9wx3yvd8g"
    nextVersions="_hyw_h2pBEeS4VPLpYyQgxQ"
    previousVersion="__eyjZwvgEeK9Xewg3qiFQA"
    name="DiagnosticResponse"
    definition="Information related to the diagnostic response."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="DgnstcRspn"
    complexType="_jVPTETTbEeO5e9wx3yvd8g" />
  <messageBuildingBlock
    xmi:id="_Rt4lZzTcEeO5e9wx3yvd8g"
    nextVersions="_hyw_iWpBEeS4VPLpYyQgxQ"
    previousVersion="__eyjawvgEeK9Xewg3qiFQA"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_KpedcTF5EeO118ZQJgaQSQ" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="014"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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