Clover API Provider Setup

API Provider Setup

On this page

To authenticate a Clover element instance you must register an app with Clover. When you authenticate, use the App ID, App Secret, and Site URL as the OAuth API Key, OAuth API Secret, and OAuth Callback URL.

In addition, the app that you want to connect to must be in use by a merchant and you must know that Merchant ID.

See the latest setup instructions in the Clover documentation.

Locate Credentials for Authentication

If you already created an application, follow the steps below to locate the App ID, App Secret, Site URL, and Merchant ID. If you have not created an app, see Create an Application.

To find your OAuth 2.0 credentials and Merchant ID:

  1. Log in to your account at Clover.
  2. Locate the application that you want to connect, and then click Settings.
  3. Record the App ID, App Secret, and Site URL for your app. Key secret and URL
  4. Click Merchants, and then record the Merchant ID. Merchant ID

Create an Application

If you have not created an application, you need one to authenticate with Clover. You also need to add pricing to the app and have at least one merchant connect to it.

To create an application:

  1. Log in to your account at Clover.
  2. Click Create New App.
  3. Complete the required information.
  4. Click Create.
  5. Click Settings. Settings
  6. Click Web Configuration, and then in Site URL enter the OAuth Callback URL.
  7. Click Save.
  8. Record the App ID, App Secret, and Site URL for your app. Key secret and URL
  9. Scroll down, and then click Required Permissions.
  10. Select all applicable permissions for your app, and then click Save.
  11. Click Pricing on the left, and then set up your pricing options. You must add at least one subscription in addition to a free trial to preview the app.
  12. Return to Your Apps .
  13. Click Preview in App Market. Preview
  14. Using a test merchant, select a subscription, and the click Accept and Install.

    You're returned to the Site URL for your app.

  15. Return to Your Apps, and then click Merchants under the app that you just tested. Merchants

  16. Record the Merchant ID. Merchant ID