Use test merchant IDs and API tokens

United States
Canada
Europe
Latin America

Clover assigns a unique merchant ID ({mId}) to every merchant business. Use the {mId} when making Clover REST API calls.

In this topic, we walk you through the process of locating your test merchant ID and creating a test API token on the sandbox Developer Dashboard. This information is important for you to test interactions with Clover REST API and for Android development.

These instructions are for development and testing only. A production app must generate tokens using OAuth or using the Android SDK.

Locate the test merchant ID

  1. Log in to the sandbox Developer Dashboard.
  2. From the Developer Account drop-down list, select a merchant name under Businesses. The Merchant Dashboard for the selected merchant appears.
  3. From the left navigation menu, click Account & Setup. The Account & Setup page appears.
  4. In the About Your Business section, click Merchants. The User Settings page displays the merchant ID for the selected merchant. Merchant ID is the 13-alphanumeric identifier below the merchant name in the Merchant column.
2840
  1. To view another merchant ID, enter search criteria in the Search merchants by name, ID, city field, and click Search. The merchant information displays in the search results grid.

Generate a test API token

🚧

IMPORTANT

Production apps must use API tokens generated using OAuth or the Clover Android SDK. Test API tokens generated from the sandbox Merchant Dashboard are intended for development and testing only. In production environments, test API tokens have additional restrictions and are more severely rate limited.

With your test API token, you can make a REST API call and access Clover merchant data. You can create as many test API tokens as required.
To generate a test API token:

  1. Log in to the Developer Dashboard.
  2. From the Developer Account drop-down list, select a merchant name under Businesses. The test Merchant Dashboard appears.
  3. From the left navigation menu, click Account & Setup. The Account & Setup page appears.
  4. In the Business Operations section, click API Tokens.
2650

The API Tokens page appears.

  1. Click Create New Token. A Create new token pop-up appears.
3456
  1. Enter a token name and set permissions based on the test merchant information you want to manage.
1296

The Create new token popup displays app permissions that map to platform API endpoints. See API Reference > Platform API section.

  1. Click Create Token. The new token displays in the Tokens section.
  2. Expand the Permissions section to view the permissions associated with the API token.
2450

See Using Clover REST API and Using API Tokens for more information about using your API token to access merchant data.