Test API tokens generated from the sandbox Merchant Dashboard are intended for development and testing only. The merchant identifier merchantId and the test API token are important for you to test interactions with Clover REST API and for Android development.

The instructions in this topic for locating your test merchantId and creating a test API token on the Developer Dashboard are for development and testing only. Production apps must use API tokens generated using the relevant OAuth flow or the Clover Android SDK. In production environments, test API tokens have additional restrictions with rate limits.

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.

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.

5. 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.

🚧

IMPORTANT

Generate a merchant-specific test API token in sandbox

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

Prerequisites

• Create a sandbox developer account.
• Create test merchant account.

Steps

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.

The API Tokens page appears.

5. Click Create New Token. The Create new token pop-up displays app permissions that map to platform API endpoints. See API Reference > Platform API section.

6. Enter a token name.
7. Select checkboxes to set permissions based on the test merchant information you want to manage. API tokens are scoped to grant specific permissions to make sure that apps only have access to the resources they need.
8. Click Create Token. The new token displays in the Tokens section. Use this token as the Bearer token to make calls to the Clover Platform API endpoints.
9. Expand the Permissions section to view or edit the permissions associated with the API token.