triPOS®

Idle Endpoint

Idle Endpoint

Use the POST /api/v1/idle endpoint to return the PIN pad to the idle screen that displays the idle message or idle logo image depending on pinPadIdleMessage or idleScreen defined in triPOS.config. See idle screen documentation for details.

This endpoint can be used in conjunction with the custom forms endpoints such as GET /api/v1/selection and GET /api/v1/signature. To create a homogenous flow, the screens used by these custom forms endpoints will remain on the PIN pad screen until the client sends another request. The idle endpoint can be used to return to the idle welcome message screen after using one of the custom forms endpoints.

Example

POST http://localhost:8080/api/v1/idle
Body: {"laneId":"1"}