Displaying the welcome screen

The welcome screen is intended to display once the transaction is complete and the customer is done interacting with the device. Use the /v1/device/welcome endpoint to display the welcome screen.

🚧

IMPORTANT

End your customer transactions with a call to the Welcome or Thank You screen; otherwise, the spinning icon displays on the screen until another action is taken.

Prerequisites

The POS is connected to the device using a network or cloud connection.

Steps

  1. Send an empty POST request to the /v1/device/welcome endpoint.
  2. Required. Include the required headers for your request.
    The welcome screen displays on the device and an empty JSON object is returned.

The welcome message remains on the screen until you take another action.


Did this page help you?