Diagnosis

Diagnosis request can be used to check connectivity

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

Example request

{
  "SaleToPOIRequest": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "ServiceID": "24",
      "MessageClass": "Service",
      "MessageCategory": "Diagnosis",
      "MessageType": "Request",
      "SaleID": "ECR123",
      "POIID": "AT12345"
    },
    "DiagnosisRequest": {
      "HostDiagnosisFlag": true
    }
  }
}
PropertyDescriptionMandatory / Optional
DiagnosisRequestMandatory
HostDiagnosisFlagTrue or False. Indicates if connectivity to host should be checked.Optional

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
        }
      ]
    }
  }
}
PropertyDescriptionMandatory / Optional
DiagnosisResponseMandatory
ResponseMandatory
ResultSuccess or FailureMandatory
LoggedSaleIDName of ECR logged into the terminalOptional
HostStatusIs present if request.HostDiagnosisFlag is TrueOptional
AcquirerIDMandatory
IsReachableFlagTrue or FalseMandatory

Did this page help you?