Get started with REST Pay Display
North America
Europe
Latin America
REST Pay Display API development checklist
Use the REST Pay Display API development checklist to integrate your point-of-sale (POS) with Clover.
1. Global Developer Dashboard tasks
| Step | Task | Description |
|---|---|---|
| 1. | Create a global developer account. | - If you're building new apps for Clover merchants across North America, Europe, Latin America, or Asia Pacific, create a new global developer account. This single account gives you access to both sandbox and production environments on the Global Developer Dashboard. - If you have existing and approved apps on the legacy developer platform, you can continue to use the Developer Dashboard to manage them. The developer platform requires two separate developer accounts to access the sandbox and production environments. |
| 2. | Create a semi-integrated app. | Create, test, and manage your web app in the sandbox environment. Configure your web app to include the required REST settings to support the OAuth flow. |
| 3. | For payment integrations, Create Remote App ID (RAID). | When your integration connects to a Clover device, your app must pass a Remote App ID (remoteApplicationID or RAID) generated for your Clover app. RAID is separate from your Clover App ID, and both IDs are needed to launch a semi-integration with Clover. |
| 4. | Work with your test merchant account. | See the following developer guides for information on building your application: - Clover REST API to build web apps. - Clover Android Payments API to build a native point-of-sale (POS) application directly on a Clover device and to process payments from your Android app on a variety of Clover device configurations. - REST Pay Display API to build a semi-integrated application on a Clover device connected to your POS. |
2. Integration tasks
| Step | Task | Description |
|---|---|---|
| 1. | Get an OAuth token. | Clover OAuth 2.0 framework requires you to retrieve an expiring token (access and refresh token pair) before accessing merchant information, such as inventory, orders, and payments. You need to authorize merchants to access your app from the Clover App Market when it is in the production environment. When an authorized merchant is redirected to your app with an authorization code, the Clover server uses the code to confirm that your request for merchant data is authorized by the merchant. Important: Be sure to use an OAuth-generated API token—not a merchant token—to make REST Pay Display requests. Using a merchant token returns an error response. |
| 2. | Configure your POS connection. | Your POS can connect to the Clover Flex or Clover Mini using a local network connection or a cloud connection to the Clover servers. |
| 3. | Build your merchant/customer workflows. | See the REST Pay Display tutorials and the REST Pay Display APIs in the API Reference. |
| 4. | Create and submit your app in the production environment. | On the Global Developer Dashboard, turn off the Sandbox toggle icon to access the production environment. Complete the developer account verification and approval process in the production environment. Re-create your app in the production environment, and then test and submit your app for approval. |
Updated about 6 hours ago