AcceptorDiagnosticResponseV04

caaa.014.001.04

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
%% AcceptorDiagnosticResponseV04 recursion level 0 with max 0
AcceptorDiagnosticResponseV04 *-- "1..1" Header10 : Header
AcceptorDiagnosticResponseV04 *-- "1..1" AcceptorDiagnosticResponse4 : DiagnosticResponse
AcceptorDiagnosticResponseV04 *-- "1..1" ContentInformationType11 : 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
%% 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

DiagnosticResponse building block

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

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

AcceptorDiagnosticResponse4 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
%% 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

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorDiagnosticResponseV04 --|> IOuterRecord : Implements
    AcceptorDiagnosticResponseV04Document --|> IOuterDocument~AcceptorDiagnosticResponseV04~ : Implements
    class IOuterDocument~AcceptorDiagnosticResponseV04~ {
        AcceptorDiagnosticResponseV04 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AcceptorDiagnosticResponseV04Document *-- AcceptorDiagnosticResponseV04 : 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.04">
    <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="_hyw_gWpBEeS4VPLpYyQgxQ"
  nextVersions="_SGaJwY3YEeW56qaqQ8B0kQ"
  previousVersion="_Rt4lYTTcEeO5e9wx3yvd8g"
  name="AcceptorDiagnosticResponseV04"
  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="_hyw_g2pBEeS4VPLpYyQgxQ"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_hyw_hWpBEeS4VPLpYyQgxQ"
    nextVersions="_SGaJxY3YEeW56qaqQ8B0kQ"
    previousVersion="_Rt4lYzTcEeO5e9wx3yvd8g"
    name="Header"
    definition="Diagnostic response message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_EXmNsWeeEeSh-d9-KfCEyA" />
  <messageBuildingBlock
    xmi:id="_hyw_h2pBEeS4VPLpYyQgxQ"
    nextVersions="_SGaJx43YEeW56qaqQ8B0kQ"
    previousVersion="_Rt4lZTTcEeO5e9wx3yvd8g"
    name="DiagnosticResponse"
    definition="Information related to the diagnostic response."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="DgnstcRspn"
    complexType="_p4UxYWpBEeS4VPLpYyQgxQ" />
  <messageBuildingBlock
    xmi:id="_hyw_iWpBEeS4VPLpYyQgxQ"
    nextVersions="_SGaJyY3YEeW56qaqQ8B0kQ"
    previousVersion="_Rt4lZzTcEeO5e9wx3yvd8g"
    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="014"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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