The Clover sandbox environment allows you to develop and test your application separate from real merchant accounts and transactions. To integrate your point of sale (POS) with a Clover Dev Kit, you need to create a sandbox app that your test merchant can install. The app allows you to configure the required merchant permissions and links (URLs) needed to retrieve OAuth tokens.

Prerequisite

Create a sandbox developer account and test merchant as described in Set up a sandbox account.

Create a new app

1. Log in to the Developer Dashboard.
2. Click Create App. The Create App window appears.
3. In the App Name field, enter a name for the app.
4. Select one or more countries where you want to make your app available for Clover merchants.
5. Click Create. The App name - App Settings page appears.

Set the app type

External point of sale (POS) apps using the REST Pay API are not available on the public Clover app market, but your Clover app is visible to the merchants using your integrated POS.
To set the type of your app:

1. Complete the steps to create an app.
2. On the App Settings page, click App Type. The App Type page appears.
3. In the REST Clients section, click Web.
4. For—Is this app an integration of an existing point of sale?—option, select Yes.
5. Click Save. The App Settings—App Type section displays a Remote App identifier (RAID) that uniquely identifies your semi-integrated app. For more information, see Create your Remote App ID.

🚧

IMPORTANT

For OAuth to work properly for a REST Pay web app, your app must have a Remote Application identifier (RAID) set. RAID is necessary to establish a connection and allows Clover to associate payments with your integration.

Set app permissions for card-present transactions

To complete payment on the Clover device, you must authorize your app to read merchant data from Clover.

1. Complete the steps to create an app.
2. On the App Settings page, click Requested Permissions. The Edit Requested Permissions page appears.
3. Select the READ checkbox for Merchant.
4. Click Save. The app permissions are updated.

(Optional) Set app permissions for card-not-present transactions

If your app allows merchants to create and use ECOMM_COMPAT card tokens for card-not-present transactions, you also need to configure your app for the Ecommerce API.

1. Complete the steps to create an app.
2. On the App Settings page, click Requested Permissions. The Edit Requested Permissions page appears.
3. Select the READ checkbox for Merchant.
4. In the Ecommerce section, select the Enable online payments checkbox. The Ecommerce Settings section displays on the App Settings page.

3. Click Save. The app permissions are updated on the App Settings page.
4. Click Ecommerce Settings. The Edit Ecommerce Settings page appears.
5. On the Edit Ecommerce Settings page, select the API checkbox.
6. Click Save.

Set up the REST configuration

Your app needs OAuth tokens to authenticate API calls. You must configure a link (URL) for the OAuth flow:

1. Complete the steps to create an app.
2. On the App Settings page, click REST Configuration. The Edit REST Configuration page appears.
3. In the Site URL field, enter the link (URL) of the home page of your web app.
4. Optionally, if you are integrating with Cloud Pay Display, enter a domain link (URL) in the CORS Domain field. When you set a CORS domain URL, your web app can call the Clover REST API without requiring an intermediate app server. For more information, see Set app URL and CORS.
5. In the Default OAuth Response field, select Code. When your merchant is authorized through OAuth 2.0, you receive an authorization code. This code is required to request an API token for your app permissions.
6. Click Save. The web configuration settings are updated.