Use test merchant identifier and API token

United States
Canada
Europe
Latin America

The merchant identifier (merchantId) and the test API token are important for you to test interactions with Clover REST API and for Android development. In this topic, we walk you through the procedures for locating your test merchantId and creating a test API token on the Developer Dashboard. These instructions are for development and testing only. Production apps must use API tokens generated using the relevant OAuth flow or the Clover Android SDK.

Locate the test merchant identifier (merchantId)

Clover assigns a universally unique identifier (UUID) known as the merchantId to every merchant business. You can search for and view merchantId in both the sandbox and production environments. This merchantId is needed when you make Clover REST API calls.

To locate the merchantId:

  1. Log in to the 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.
1608

Merchant Dashboard—Account & Setup

The User Settings page displays the merchantId for the selected merchant. The merchantId is the 13-alphanumeric identifier below the merchant name in the Merchant column.

3266

Merchant Dashboard—User Settings

  1. To view another merchantId, 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 the relevant OAuth flow 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 with rate limits.

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

For more information about using your API token to access merchant data, see: