kepa
Device Interaction/displayOnTerminal

Display on Terminal

Push branded text or status messages to the terminal screen.

POST/v1/device/display
Render text on the terminal screen — useful for idle-screen branding, order summaries while the cardholder pays, or status messages between transactions. The display clears automatically after duration milliseconds, or persists until the next display call or transaction begins.

Request body

application/json

linesarrayrequired

Lines of text to display (1–10).

durationinteger

Duration in milliseconds. 0 or omitted = persistent until replaced.

Example: 10000
clearPreviousboolean

Clear the screen before displaying new content.

Example: true

Response

application/json

successboolean

Whether the display was accepted.

Example: true

commerce-api/openapi.yaml · displayOnTerminal

POSTLocal
http://terminal:8443/v1/device/display
Request
curl http://terminal:8443/v1/device/display \
  -H "X-Api-Key: $ATLAS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"lines": [{ "text": "Welcome to Atlas Coffee", "alignment": "CENTER", "fontSize": "LARGE", "bold": true },{ "text": "Tap to pay", "alignment": "CENTER", "fontSize": "MEDIUM", "bold": false }],"duration": 10000,"clearPrevious": true}'
Response
{ "success": true }