Configuring a cloud connection

Prerequisites

Your POS app must be installed by the merchant and they must complete the OAuth flow so your app has the bearer token needed to authenticate your requests.

Installing the Cloud Pay Display app

A cloud connection requires that your merchant's device run the Cloud Pay Display app. To install this app, complete the steps in one of the following sections.

Installing from the web dashboard

  1. Log on to the merchant dashboard.
  2. On the sidebar, click More Tools and then click Apps By Clover.
  3. In the search bar, type cloud and click the Cloud Pay Display result.
  4. On the Cloud Pay Display page, click Connect.
    The app is automatically downloaded and installed on all the merchant's devices.

Installing on the device

  1. On the home screen, tap More Tools.
  2. Tap the magnifying glass icon, type cloud, and tap the Cloud Pay Display result.
  3. On the Cloud Pay Display page, tap Connect.
  4. On the Install Cloud Pay Display page, tap Connect.
    The app is automatically downloaded and installed on all the merchant's devices.

Starting the app

The Cloud Pay Display app must be running in order to accept requests from your POS app. To start the app, do the following:

  1. On the home screen, tap Cloud Pay Display.
  2. Tap Start.
    The welcome screen appears.

Building a request

A cloud request is built using these components:

  • An environment- and region-specific base URL
  • The required headers (X-Clover-Merchant-Id, X-Clover-Device-Id, and X-POS-ID)
  • The resource (endpoint) being used
  • The request body

For PCI compliance, all requests must be made using a secure (HTTPS) connection.

Example requests

Show a message on the device

var request = require("request");

var options = {
  method: 'POST',
  url: 'https://sandbox.dev.clover.com/connect/v1/device/display',
  headers: {
    accept: 'application/json',
    'x-clover-merchant-id': 'merchantUUID',
    'x-clover-device-id': 'deviceUUID',
    'x-pos-id': 'MyPOS',
    'content-type': 'application/json',
    authorization: 'Bearer OauthToken'
  },
  body: '{"text":"A message to show on the device","beep":true}'
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Did this page help you?