Diagnosis

Message category	Class	Direction
`Diagnosis`	Service	ECR → terminal

📘
Used in these guides
Implement the payment flow · Check the connection · Test and get approved

Diagnosis request can be used to check connectivity between the ECR and the terminal, and between the terminal and the payment host.

Example request and response

diagnosis

All fields

Example request

{
  "SaleToPOIRequest": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "ServiceID": "24",
      "MessageClass": "Service",
      "MessageCategory": "Diagnosis",
      "MessageType": "Request",
      "SaleID": "ECR123",
      "POIID": "AT12345"
    },
    "DiagnosisRequest": {
      "HostDiagnosisFlag": true
    }
  }
}

Field	Required	Description
`DiagnosisRequest`	Required	Contains the fields below
↳ `HostDiagnosisFlag`	Optional	True or False. Indicates if connectivity to host should be checked.

Example response

{
  "SaleToPOIResponse": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "MessageClass": "Service",
      "MessageCategory": "Diagnosis",
      "MessageType": "Response",
      "ServiceID": "24",
      "SaleID": "ECR123",
      "POIID": "AT12345"
    },
    "DiagnosisResponse": {
      "Response": {
        "Result": "Success"
      },
      "LoggedSaleID": [
        "ECR123"
      ],
      "HostStatus": [
        {
          "AcquirerID": "AERA_GW",
          "IsReachableFlag": true
        }
      ]
    }
  }
}

Field	Required	Description
`DiagnosisResponse`	Required	Contains the fields below
↳ `Response`	Required	Contains the fields below
↳ `Result`	Required	Success or Failure
↳ `LoggedSaleID`	Optional	Name of ECR logged into the terminal
↳ `HostStatus`	Optional	Is present if request.HostDiagnosisFlag is True
↳ `AcquirerID`	Required
↳ `IsReachableFlag`	Required	True or False