Guides

Placeholder

This walk-through uses the placeholder Diagnosis messages. Real guides follow with the message catalog.

Send a Diagnosis request

A Diagnosis asks the terminal to check itself and, optionally, its connection to the payment host.

1. Build the request

Fill in the header with your sale system ID, the terminal ID and a new service ID. Leave the body empty for a terminal-only check:

{
  "SaleToPOIRequest": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "MessageClass": "Service",
      "MessageCategory": "Diagnosis",
      "MessageType": "Request",
      "ServiceID": "2041",
      "SaleID": "ECR-01",
      "POIID": "FISPAY-T-0001"
    },
    "DiagnosisRequest": {}
  }
}

To include the payment host, set HostDiagnosisFlag to true:

{
  "SaleToPOIRequest": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "MessageClass": "Service",
      "MessageCategory": "Diagnosis",
      "MessageType": "Request",
      "ServiceID": "2041",
      "SaleID": "ECR-01",
      "POIID": "FISPAY-T-0001"
    },
    "DiagnosisRequest": {
      "HostDiagnosisFlag": true
    }
  }
}

2. Send it

Post the JSON to the terminal endpoint (POST /). See the HTTP API.

3. Read the response

The response repeats the header with MessageType set to Response. The Result field tells you how the check went:

{
  "SaleToPOIResponse": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "MessageClass": "Service",
      "MessageCategory": "Diagnosis",
      "MessageType": "Response",
      "ServiceID": "2041",
      "SaleID": "ECR-01",
      "POIID": "FISPAY-T-0001"
    },
    "DiagnosisResponse": {
      "Response": {
        "Result": "Success"
      }
    }
  }
}

On a fault, Result is Failure:

{
  "SaleToPOIResponse": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "MessageClass": "Service",
      "MessageCategory": "Diagnosis",
      "MessageType": "Response",
      "ServiceID": "2041",
      "SaleID": "ECR-01",
      "POIID": "FISPAY-T-0001"
    },
    "DiagnosisResponse": {
      "Response": {
        "Result": "Failure"
      }
    }
  }
}

All fields are described in Diagnosis.