Getting started

Placeholder

The endpoint and message shape below are stable; the message catalog is a placeholder.

What the API is

The sale system sends a request message to the terminal and gets the matching response message back. The terminal does the payment work; the sale system only asks and reads the answer.

One endpoint

There is a single HTTP endpoint: POST / with a JSON body. The body itself says which operation it is, so new operations never need new URLs. The HTTP API page shows the contract.

The message envelope

Every request is wrapped in SaleToPOIRequest, every response in SaleToPOIResponse. Inside the wrapper there are two parts:

• MessageHeader: who is talking and which operation this is. See Message header.
• The body for that operation, for example DiagnosisRequest. See Diagnosis.

{
  "SaleToPOIRequest": {
    "MessageHeader": { "...": "..." },
    "DiagnosisRequest": {}
  }
}

Receivers ignore fields they do not know, so a newer sender keeps working with an older receiver.