Diagnostic Exchange

5 min

This section is incomplete.

A diagnostic exchange is composed of an AcceptorDiagnosticRequest message and an AcceptorDiagnosticResponse message.

An AcceptorDiagnosticRequest is a message sent by an Initiating Party to a Recipient Party to check the availability, security or the configuration of the dialogue with the Recipient Party.

The Diagnostic message has been designed to perform specific administrative tasks without relying on “dummy” messages.

An AcceptorDiagnosticResponse message is sent back by the RecipientParty to the InitiatingParty to confirm the availability of the RecipientParty.

An AcceptorDiagnosticRequest message is used to:

Confirm the identification of the partners of the exchanges

Ensure that security on both sides of the dialogue is synchronised

Test the communication with a RecipientParty

Endorse the version of the configuration parameters.

If the AcceptorDiagnosticRequest message is received without errors by the Recipient Party, an AcceptorDiagnosticResponse message is sent back by the Recipient Party to the Initiating Party.

The Recipient Party uses an AcceptorDiagnosticResponse message to request the Initiating Party to notify the Recipient Party about any maintenance operations that may be required.

If the RecipientParty receives an AcceptorDiagnosticRequest message with errors or cannot process the message, an AcceptorRejection message is returned to the InitiatingParty with the appropriate RejectReason.

Request HTTP Parameters

URL: /v1/caaa/diagnostic-request

HTTP verb: POST

Request Message

Use ISO20022 message definition Acceptor (message identifier: caaa.013.001.010).

It is recommended to use the ISO 20022 Dictionary to determine the complete structure of the message:

https://www.iso20022.org/standardsrepository/type/AcceptorDiagnosticRequestV01

Please note the following additional requirements:

Property Header of type Header1 (child of AcceptorDiagnosticRequestV01) is mandatory.

Property SecurityTrailer of type ContentInformationType3 (child of AcceptorDiagnosticRequestV01) is mandatory.

Examples

The messages provided below are formatted for readability. When sending requests to the gateway, the request body should be compacted by removing all non-significant whitespace characters.

Example Acceptor Diagnostic Request

<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:iso:std:iso:20022:tech:xsd:caaa.013.001.12">
    <AccptrDgnstcReq>
        <Hdr>
            <MsgFctn>DGNP</MsgFctn>
            <PrtcolVrsn>9.0</PrtcolVrsn>
            <XchgId>823779899142203</XchgId>
            <CreDtTm>2025-10-20T11:34:53.661Z</CreDtTm>
            <InitgPty>
                <Id>merch_42652191</Id>
                <Tp>MERC</Tp>
                <Issr>ACQR</Issr>
            </InitgPty>
            <RcptPty>
                <Id>toro-gateway</Id>
                <Tp>ITAG</Tp>
            </RcptPty>
        </Hdr>
        <DgnstcReq>
            <Envt>
                <POI>
                    <Id>
                        <Id>poi_12345abcde</Id>
                    </Id>
                    <Cmpnt>
                        <Tp>MDWR</Tp>
                        <SubTpInf>Toro-Android-SDK</SubTpInf>
                        <Id>
                            <PrvdrId>ccs</PrvdrId>
                        </Id>
                        <Sts>
                            <VrsnNb>0.4.8</VrsnNb>
                        </Sts>
                    </Cmpnt>
                </POI>
            </Envt>
        </DgnstcReq>
        <SctyTrlr>
            <CnttTp>AUTH</CnttTp>
            <AuthntcdData>
                <Rcpt>
                    <KeyIdr>
                        <KeyId>SpecV1TestKey</KeyId>
                        <KeyVrsn>1</KeyVrsn>
                    </KeyIdr>
                </Rcpt>
                <MACAlgo>
                    <Algo>CCA3</Algo>
                </MACAlgo>
                <NcpsltdCntt>
                    <CnttTp>DATA</CnttTp>
                </NcpsltdCntt>
                <MAC>fw7vsjLiplm41G4I7SpxaB==</MAC>
            </AuthntcdData>
        </SctyTrlr>
    </AccptrDgnstcReq>
</Document>

Example Acceptor Diagnostic Response

<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns:None="urn:iso:std:iso:20022:tech:xsd:caaa.014.001.10" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:iso:std:iso:20022:tech:xsd:caaa.014.001.10">
    <AccptrDgnstcRspn>
        <Hdr>
            <MsgFctn>DGNQ</MsgFctn>
            <PrtcolVrsn>9.0</PrtcolVrsn>
            <XchgId>823779899142203</XchgId>
            <CreDtTm>2025-10-22T15:48:47.410Z</CreDtTm>
            <InitgPty>
                <Id>merch_42652191</Id>
                <Tp>MERC</Tp>
                <Issr>ACQR</Issr>
            </InitgPty>
            <RcptPty>
                <Id>toro-gateway</Id>
                <Tp>ITAG</Tp>
            </RcptPty>
        </Hdr>
        <DgnstcRspn>
            <Envt>
                <POI>
                    <Id>
                        <Id>poi_12345abcde</Id>
                    </Id>
                    <Cmpnt>
                        <Tp>MDWR</Tp>
                        <SubTpInf>Toro-Android-SDK</SubTpInf>
                        <Id>
                            <PrvdrId>ccs</PrvdrId>
                        </Id>
                        <Sts>
                            <VrsnNb>0.4.8</VrsnNb>
                        </Sts>
                    </Cmpnt>
                </POI>
            </Envt>
        </DgnstcRspn>
        <SctyTrlr>
            <CnttTp>AUTH</CnttTp>
            <AuthntcdData>
                <Vrsn>0</Vrsn>
                <Rcpt>
                    <KeyIdr>
                        <KeyId>SpecV1TestKey</KeyId>
                        <KeyVrsn>1</KeyVrsn>
                    </KeyIdr>
                </Rcpt>
                <MACAlgo>
                    <Algo>CCA3</Algo>
                </MACAlgo>
                <NcpsltdCntt>
                    <CnttTp>DATA</CnttTp>
                </NcpsltdCntt>
                <MAC>0soP4taCbqBVcDeF5Zyy8A==</MAC>
            </AuthntcdData>
        </SctyTrlr>
    </AccptrDgnstcRspn>
</Document>