caaa.014.001.08
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
%% AcceptorDiagnosticResponseV08 recursion level 0 with max 0
AcceptorDiagnosticResponseV08 *-- "1..1" Header59 : Header
AcceptorDiagnosticResponseV08 *-- "1..1" AcceptorDiagnosticResponse7 : DiagnosticResponse
AcceptorDiagnosticResponseV08 *-- "0..1" ContentInformationType27 : 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
%% Header59 recursion level 0 with max 1
class Header59{
MessageFunction MessageFunction42Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoNumber
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header59 *-- "1..1" GenericIdentification176 : InitiatingParty
Header59 *-- "0..1" GenericIdentification177 : RecipientParty
Header59 *-- "0..0" Traceability8 : Traceability
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
Identification IsoMax35Text
Type PartyType33Code
Issuer PartyType33Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% GenericIdentification177 recursion level 1 with max 1
class GenericIdentification177{
Identification IsoMax35Text
Type PartyType33Code
Issuer PartyType33Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
GenericIdentification177 *-- "0..1" NetworkParameters7 : RemoteAccess
GenericIdentification177 *-- "0..1" Geolocation1 : Geolocation
%% Traceability8 recursion level 1 with max 1
class Traceability8{
ProtocolName IsoMax35Text
ProtocolVersion IsoMax6Text
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability8 *-- "1..1" GenericIdentification177 : RelayIdentification
Header59 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction42Code - 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 |
| ReTransmissionCounter | Number of retransmissions of the message. | IsoMax3NumericText - Optional 0..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. | GenericIdentification176 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification177 - Optional 0..1 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability8 - Unknown 0..0 |
DiagnosticResponse building block
Information related to the diagnostic response. Diagnostic response from the acquirer. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% AcceptorDiagnosticResponse7 recursion level 0 with max 1
class AcceptorDiagnosticResponse7{
AcquirerAvailable IsoTrueFalseIndicator
}
AcceptorDiagnosticResponse7 *-- "1..1" CardPaymentEnvironment77 : Environment
AcceptorDiagnosticResponse7 *-- "0..1" TMSTrigger1 : TMSTrigger
%% CardPaymentEnvironment77 recursion level 1 with max 1
CardPaymentEnvironment77 *-- "0..1" Acquirer10 : Acquirer
CardPaymentEnvironment77 *-- "0..1" Organisation41 : Merchant
CardPaymentEnvironment77 *-- "0..1" PointOfInteraction11 : POI
CardPaymentEnvironment77 *-- "0..1" PaymentCard31 : Card
CardPaymentEnvironment77 *-- "0..1" Check1 : Check
CardPaymentEnvironment77 *-- "0..0" StoredValueAccount2 : StoredValueAccount
CardPaymentEnvironment77 *-- "0..0" LoyaltyAccount2 : LoyaltyAccount
CardPaymentEnvironment77 *-- "0..1" CustomerDevice3 : CustomerDevice
CardPaymentEnvironment77 *-- "0..1" CustomerDevice3 : Wallet
CardPaymentEnvironment77 *-- "0..1" Token1 : PaymentToken
CardPaymentEnvironment77 *-- "0..1" MerchantToken1 : MerchantToken
CardPaymentEnvironment77 *-- "0..1" Cardholder17 : Cardholder
CardPaymentEnvironment77 *-- "0..1" ContentInformationType28 : ProtectedCardholderData
CardPaymentEnvironment77 *-- "0..1" RetailerSaleEnvironment2 : SaleEnvironment
%% TMSTrigger1 recursion level 1 with max 1
class TMSTrigger1{
TMSContactLevel TMSContactLevel1Code
TMSIdentification IsoMax35Text
TMSContactDateTime IsoISODateTime
}
AcceptorDiagnosticResponse7 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment77 - Required 1..1 |
| TMSTrigger | Instructions for contacting the terminal management host. | TMSTrigger1 - Optional 0..1 |
| AcquirerAvailable | Indicates if the acquirer is available. | IsoTrueFalseIndicator - Optional 0..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
%% ContentInformationType27 recursion level 0 with max 1
class ContentInformationType27{
ContentType ContentType2Code
}
ContentInformationType27 *-- "1..1" AuthenticatedData7 : AuthenticatedData
%% AuthenticatedData7 recursion level 1 with max 1
class AuthenticatedData7{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData7 *-- "1..0" IRecipient10Choice : Recipient
AuthenticatedData7 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData7 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
ContentInformationType27 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). | AuthenticatedData7 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorDiagnosticResponseV08 implementation follows a specific implementaiton pattern. First of all, AcceptorDiagnosticResponseV08 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorDiagnosticResponseV08Document implements IOuterDocument. Because AcceptorDiagnosticResponseV08 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorDiagnosticResponseV08.
classDiagram
class IOuterRecord
AcceptorDiagnosticResponseV08 --|> IOuterRecord : Implements
AcceptorDiagnosticResponseV08Document --|> IOuterDocument~AcceptorDiagnosticResponseV08~ : Implements
class IOuterDocument~AcceptorDiagnosticResponseV08~ {
AcceptorDiagnosticResponseV08 Message
}
Document wrapper for serialization
The only real purpose AcceptorDiagnosticResponseV08Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.014.001.08’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorDiagnosticResponseV08.ToDocument() method. The returned AcceptorDiagnosticResponseV08Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorDiagnosticResponseV08Document *-- AcceptorDiagnosticResponseV08 : 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.08">
<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="_GhwTcS5JEeunNvJlR_vCbg"
nextVersions="_QrJMkU7TEeyGi9JAv6wq7Q"
previousVersion="_AlOJwQulEeqw5uEXxQ9H4g"
name="AcceptorDiagnosticResponseV08"
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="_GhwTcy5JEeunNvJlR_vCbg"
type="purpose" />
<messageBuildingBlock
xmi:id="_GhwTdS5JEeunNvJlR_vCbg"
nextVersions="_QrJMlU7TEeyGi9JAv6wq7Q"
previousVersion="_AlOw0wulEeqw5uEXxQ9H4g"
name="Header"
definition="Diagnostic response message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_Rz5m4S_aEeugIJ3Gvoevmg" />
<messageBuildingBlock
xmi:id="_GhwTdy5JEeunNvJlR_vCbg"
nextVersions="_QrJMl07TEeyGi9JAv6wq7Q"
previousVersion="_AlOw1QulEeqw5uEXxQ9H4g"
name="DiagnosticResponse"
definition="Information related to the diagnostic response."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="DgnstcRspn"
complexType="_CPt2gS5JEeunNvJlR_vCbg" />
<messageBuildingBlock
xmi:id="_GhwTeS5JEeunNvJlR_vCbg"
nextVersions="_QrJMmU7TEeyGi9JAv6wq7Q"
previousVersion="_AlOw1wulEeqw5uEXxQ9H4g"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_2S4usS8lEeu125Ip9zFcsQ" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="014"
flavour="001"
version="08" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.