Create an app in the production environment

United States
Canada
Europe

To integrate your point of sale (POS) with a production Clover device, you need to create a Clover app that merchants can install. The app lets you configure merchant permissions and URLs needed to retrieve OAuth tokens.

Prerequisite

Create a production developer account as described in Developer account approval.

Create a new app

  1. Log in to 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.
1182
  1. Click Create. The App name - App Settings page appears.
939

Set the app type

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

  1. Complete 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 ID (RAID) that uniquely identifies your semi-integrated app. For more information, see [Create your Remote App ID]

Set app permissions for card-present transactions

To complete a payment on the Clover device, you must authorize your app to read merchant data from a Clover device. To configure your app to request this permission:

  1. Complete 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 reason field, enter Required to connect POS app to Clover device using REST Pay API.
  5. Click Save.

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

If your app lets merchants create and use ECOMM_COMPAT card tokens for card-not-present (CNP) transactions, you must also configure your app for the Ecommerce API.

  1. Complete 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.
  5. In the Reason field, enter Required to process card-not-present transactions using REST Pay API.
  6. Click Save. The app's permissions are updated.
  7. On the App Settings page, click Ecommerce Settings. The Edit Ecommerce Settings page appears.
  8. Select the API checkbox.
  9. Click Save.

Set up the REST configuration

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

  1. Complete 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 make calls to 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 for you to request an API token for your app permissions.
  6. Click Save. The web configuration settings are updated.