Skip to main content

Activation And Health

Activation links a physical POS terminal to its OpenApp integration profile. The merchant generates a short-lived PIN in the merchant panel and the POS operator enters the merchant tax identifier and PIN into the POS. After OpenApp validates the PIN, the POS receives credentials for subsequent POS-to-OpenApp calls and, if queue delivery is configured, queue credentials for receiving OpenApp-initiated commands.

The activation call itself is a bootstrap operation and does not use HMAC signing because POS credentials do not yet exist. See Authorization.

After activation, the POS reports health to OpenApp on activation and at regular heartbeat intervals. If OpenApp does not receive health checks within the timeout configured on the integration profile, OpenApp stops sending POS-backed ordering commands and tells customers that the location is currently unavailable.

This diagram is logical. It omits delivery-mode details; see Architecture for the delivery model.

Message types:

Message typeDirectionPurpose
ActivatePosPOS -> OpenAppSubmit merchant tax identifier and PIN to activate the POS.
PosActivationResponseOpenApp -> POSReturn activation result and, on success, credentials and delivery config.
ReportPosHealthPOS -> OpenAppReport POS health on activation and at regular intervals.