Creating a sandbox app

To integrate your 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 URLs needed to retrieve OAuth tokens.

The sandbox environment allows you to develop and test your application separate from real merchant accounts and transactions.

Prerequisites

Before completing this task, you need to create a sandbox developer account and test merchant as described in Setting up a sandbox account.

Creating a new app

  1. Log on to your sandbox Developer Dashboard.
  2. Click Create App.
  3. On the Create App window, type an App Name, select one or more countries, and then click Create.
    The app is created and the App Settings page appears.

Setting the app type

External POS apps using the REST Pay API are not available on the public Clover app market, but your Clover app will be visible to the merchants using your integrated POS. To set the type of your app, do the following.

  1. On the App Settings page, click App Type.
  2. From the REST Clients list, select Web.
  3. At the prompt, "Is this app an integration of an existing point of sale?", select Yes.
    This creates a RAID (Remote Application ID) which is necessary to establish a connection and allows Clover to associate payments with your integration.
  4. Click Save.
    The settings are saved.

🚧

IMPORTANT

For OAuth to work properly for a Rest Pay webapp, the app MUST have a RAID identifier set.

Setting app permissions for card-present transactions

To complete a payment on the Clover device, your app must be authorized to read merchant data from Clover. To configure your app to request this permission, do the following.

  1. On the App Settings page, click Requested Permissions.
  2. On the Edit Requested Permissions page, select the READ checkbox for Merchant.
  3. Click Save.
    The app's permissions are updated.

(Optional) Setting 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. To configure your app for the Ecommerce API, do the following:

  1. On the App Settings page, click Requested Permissions.
  2. On the Edit Requested Permissions page, select the Merchant READ and the Ecommerce Enable online payments checkboxes. In the sandbox environment, you can leave the reason box empty.
  1. Click Save.
    The app's permissions are updated.
  2. On the App Settings page, click Ecommerce Settings.
  3. On the Edit Ecommerce Settings page, select the API checkbox.
  4. Click Save.

Setting the REST configuration

Because your app needs OAuth tokens to authenticate API calls, you must configure a URL for the OAuth flow. To set this, do the following.

  1. On the App Settings page, click REST Configuration.
  2. On the Edit REST Configuration page, type your app's URL in the Site URL field.
  3. (Optional) If you are integrating with Cloud Pay Display, type your app's domain in the CORS Domain field.
  4. Under Default OAuth Response, select Code.
  5. Click Save.
    The web configuration settings are updated.

For more information about these configuration options, see Setting app URL & CORS.


Did this page help you?