caaa.013.001.11
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
%% AcceptorDiagnosticRequestV11 recursion level 0 with max 0
AcceptorDiagnosticRequestV11 *-- "1..1" Header70 : Header
AcceptorDiagnosticRequestV11 *-- "1..1" AcceptorDiagnosticRequest11 : DiagnosticRequest
AcceptorDiagnosticRequestV11 *-- "0..1" ContentInformationType36 : 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
%% Header70 recursion level 0 with max 1
class Header70{
MessageFunction MessageFunction46Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoNumber
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header70 *-- "1..1" GenericIdentification176 : InitiatingParty
Header70 *-- "0..1" GenericIdentification177 : RecipientParty
Header70 *-- "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
Header70 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction46Code - 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 |
DiagnosticRequest building block
Information related to the diagnostic request. Diagnostic request from an acceptor. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% AcceptorDiagnosticRequest11 recursion level 0 with max 1
class AcceptorDiagnosticRequest11{
AcquirerAvailabilityRequested IsoTrueFalseIndicator
}
AcceptorDiagnosticRequest11 *-- "1..1" CardPaymentEnvironment79 : Environment
%% CardPaymentEnvironment79 recursion level 1 with max 1
CardPaymentEnvironment79 *-- "0..1" Acquirer10 : Acquirer
CardPaymentEnvironment79 *-- "0..1" Acquirer10 : ServiceProvider
CardPaymentEnvironment79 *-- "0..1" Organisation41 : Merchant
CardPaymentEnvironment79 *-- "0..1" PointOfInteraction13 : POI
CardPaymentEnvironment79 *-- "0..1" PaymentCard33 : Card
CardPaymentEnvironment79 *-- "0..1" Check1 : Check
CardPaymentEnvironment79 *-- "0..0" StoredValueAccount2 : StoredValueAccount
CardPaymentEnvironment79 *-- "0..0" LoyaltyAccount3 : LoyaltyAccount
CardPaymentEnvironment79 *-- "0..1" CustomerDevice3 : CustomerDevice
CardPaymentEnvironment79 *-- "0..1" CustomerDevice3 : Wallet
CardPaymentEnvironment79 *-- "0..1" Token1 : PaymentToken
CardPaymentEnvironment79 *-- "0..1" MerchantToken2 : MerchantToken
CardPaymentEnvironment79 *-- "0..1" Cardholder20 : Cardholder
CardPaymentEnvironment79 *-- "0..1" ContentInformationType35 : ProtectedCardholderData
CardPaymentEnvironment79 *-- "0..1" RetailerSaleEnvironment2 : SaleEnvironment
AcceptorDiagnosticRequest11 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment79 - Required 1..1 |
| AcquirerAvailabilityRequested | Indicates if the availability of the acquirer must be tested. | 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
%% ContentInformationType36 recursion level 0 with max 1
class ContentInformationType36{
ContentType ContentType2Code
}
ContentInformationType36 *-- "1..1" AuthenticatedData9 : AuthenticatedData
%% AuthenticatedData9 recursion level 1 with max 1
class AuthenticatedData9{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData9 *-- "1..0" IRecipient14Choice : Recipient
AuthenticatedData9 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData9 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
ContentInformationType36 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). | AuthenticatedData9 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorDiagnosticRequestV11 implementation follows a specific implementaiton pattern. First of all, AcceptorDiagnosticRequestV11 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorDiagnosticRequestV11Document implements IOuterDocument. Because AcceptorDiagnosticRequestV11 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorDiagnosticRequestV11.
classDiagram
class IOuterRecord
AcceptorDiagnosticRequestV11 --|> IOuterRecord : Implements
AcceptorDiagnosticRequestV11Document --|> IOuterDocument~AcceptorDiagnosticRequestV11~ : Implements
class IOuterDocument~AcceptorDiagnosticRequestV11~ {
AcceptorDiagnosticRequestV11 Message
}
Document wrapper for serialization
The only real purpose AcceptorDiagnosticRequestV11Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.013.001.11’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorDiagnosticRequestV11.ToDocument() method. The returned AcceptorDiagnosticRequestV11Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorDiagnosticRequestV11Document *-- AcceptorDiagnosticRequestV11 : 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.11">
<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="_DOZZAXMaEe2vXY6MoVq19w"
previousVersion="_7Z1LEU7SEeyGi9JAv6wq7Q"
name="AcceptorDiagnosticRequestV11"
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="_uZD3QJVOEeO6Q83g-JIX_w"
xmlTag="AccptrDgnstcReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<doclet
xmi:id="_DOZZA3MaEe2vXY6MoVq19w"
type="purpose" />
<messageBuildingBlock
xmi:id="_DOZZBXMaEe2vXY6MoVq19w"
previousVersion="_7Z1LFU7SEeyGi9JAv6wq7Q"
name="Header"
definition="Diagnostic request message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_15eK4XJLEe299ZbWCkdR_w" />
<messageBuildingBlock
xmi:id="_DOZZB3MaEe2vXY6MoVq19w"
previousVersion="_7Z1LF07SEeyGi9JAv6wq7Q"
name="DiagnosticRequest"
definition="Information related to the diagnostic request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="DgnstcReq"
complexType="_Jf9WkXJ-Ee299ZbWCkdR_w" />
<messageBuildingBlock
xmi:id="_DOZZCXMaEe2vXY6MoVq19w"
previousVersion="_7Z1LGU7SEeyGi9JAv6wq7Q"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_WAiXsXJ9Ee299ZbWCkdR_w" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="013"
flavour="001"
version="11" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.