Merchant ID and API Token for development

The following guide will walk you through the process of finding your Merchant ID and creating an API Token. You’ll need this information to test interactions with Clover’s REST API and for Android development.

Important

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

Get your test merchant’s UUID (mId)

Step 1. Login

Log into your Sandbox developer account.

Sandbox Login Screen

Step 2. Access your merchant account

Click on the user icon at the top right, then select your merchant from the drop-down menu.

Menu Bar

Click on the merchant name to go to the merchant account.

Menu Bar Dropdown

You will be taken to the merchant dashboard.
Merchant Dashboard

Note the URL in your browser window. The thirteen-character sequence of numbers and letters at the end of the URL is your Merchant ID.

For the following URL, for example, the merchant UUID would be 17ABN94ZVQVTT.

https://sandbox.dev.clover.com/home/m/17ABN94ZVQVTT

Create a test API Token

Important

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

Step 1. Setup

From the Merchant Dashboard, click Setup.
Setup Button Highlight

Step 2. Navigate to API Tokens

Click on API Tokens in the sidebar.

API Token Link Highlight

This is where you will generate your API tokens.

API Token Screen

 

Step 3. Generate an API Token

Enter a name for the token and click Generate Token.

Token Name Generate Button
The system will generate a new API Token for you.

API Token

Step 4. Customize permissions

You can customize the permissions the API Token grants by checking the appropriate boxes. 

API Token Permissions

Learn more about using your secure token to access the REST API.