Diagnosis¶
Placeholder
Generated from the placeholder schemas schemas/diagnosis-request.json
and schemas/diagnosis-response.json.
A Diagnosis asks the terminal to check its own state. The header fields fixed below tell the terminal which message it received.
Request¶
| Field | Type | Multiplicity | Description | Example |
|---|---|---|---|---|
| SaleToPOIRequest | object | 1..1 | Wrapper for every message the sale system sends to the terminal. | |
| SaleToPOIRequest.MessageHeader | object (MessageHeader) | 1..1 | Common envelope, narrowed to a diagnosis request. | |
| SaleToPOIRequest.MessageHeader.MessageClass | string, fixed: Service | 1..1 | Fixed to Service for this message. | Service |
| SaleToPOIRequest.MessageHeader.MessageCategory | string, fixed: Diagnosis | 1..1 | Fixed to Diagnosis for this message. | Diagnosis |
| SaleToPOIRequest.MessageHeader.MessageType | string, fixed: Request | 1..1 | Fixed to Request for this message. | Request |
| SaleToPOIRequest.DiagnosisRequest | object | 1..1 | Body of the diagnosis request. | |
| SaleToPOIRequest.DiagnosisRequest.HostDiagnosisFlag | boolean | 0..1 | When true, the terminal also checks that it can reach the payment host. When absent or false, only the terminal itself is checked. | true |
Response¶
| Field | Type | Multiplicity | Description | Example |
|---|---|---|---|---|
| SaleToPOIResponse | object | 1..1 | Wrapper for every message the terminal sends back to the sale system. | |
| SaleToPOIResponse.MessageHeader | object (MessageHeader) | 1..1 | Common envelope, narrowed to a diagnosis response. | |
| SaleToPOIResponse.MessageHeader.MessageClass | string, fixed: Service | 1..1 | Fixed to Service for this message. | Service |
| SaleToPOIResponse.MessageHeader.MessageCategory | string, fixed: Diagnosis | 1..1 | Fixed to Diagnosis for this message. | Diagnosis |
| SaleToPOIResponse.MessageHeader.MessageType | string, fixed: Response | 1..1 | Fixed to Response for this message. | Response |
| SaleToPOIResponse.DiagnosisResponse | object | 1..1 | Body of the diagnosis response. | |
| SaleToPOIResponse.DiagnosisResponse.Response | object | 1..1 | Outcome of the diagnosis. | |
| SaleToPOIResponse.DiagnosisResponse.Response.Result | string, one of: Success, Failure, Partial | 1..1 | Overall verdict: Success when every check passed, Failure when the diagnosis could not be done or found a fault, Partial when only some checks passed. | Success |