This guide provides information for Clover Connect ISV partners, to get started developing apps and describe the end-to-end onboarding, app development, and go-live workflow.

As a Clover Connect ISV partner, you'll use a few different portals to manage your apps, merchants, and business reporting:

  • Use the Clover Developer Portal to create a Clover Developer account and manage your apps.
  • Use CoPilot to board and manage your merchants, ship and manage devices pre-provisioned with your apps, and more.

Getting Started

The following topics provide an overview of the integration process and links to additional information to help you get started.

Integration Overview

At a high-level, the integration process consists of the following steps:

  1. Review the developer documentation to determine the best integration type for your business.
  2. Create your sandbox and production Clover Developer accounts.
  3. Once your account is approved, build and test your app(s).
  4. Once your app is ready, submit it for review and approval.
  5. Once your app is approved, start using CoPilot to board merchants and deploy your custom integration.

Developer Documentation

Check out the following developer guides for information on building your application: 

Join the Clover Developer Community for additional support and answers to frequently asked questions. 

Using CoPilot

Once your Developer account has been approved by Clover, you'll receive access to CoPilot, our portfolio management portal. You use CoPilot to manage the end-to-end merchant lifecycle, from application and setup, through device ordering and support.

See the following topics for more information on key workflows:

This guide provides information on the specific processes required for managing your ISV merchant portfolio. For more general information on using CoPilot, see the CoPilot User's Guide.

Creating and Managing Profiles

You must create at least one profile, which you will use to group apps and settings for your merchants.

A profile is a collection of private Clover apps and merchant settings. When you submit a merchant application and order a device for that merchant location, the profile that you select determines which of your apps are pre-installed on the device, as well as certain settings for the merchant's checkout experience. This ensures a smooth out-of-box experience for you and your merchants.

To create a profile, do the following:

  1. Click Dashboard in the left pane to access your Dashboard.
  2. On the dashboard, select the Clover tab.
  3. On the Clover Tab, select Apps & Settings.
  4. Click Create Profile
  5. On the Create Profile screen, fill in the following details:
    1. Enter a unique Name to identify this profile (for example, "Restaurants").
    2. Select the Developer ID associated with the apps that you want to include in this profile.
    3. Under Select Your Apps, select one or more of your apps that you want to install on all devices using this profile.
    4. Under Suppress Pre-Installed Apps, select the default Clover apps that you want to hide from your merchants. These apps will still be installed on your merchants' devices; however they will be hidden from view.
    5. Under Select Merchant Settings, specify the following default settings for your merchants:

      Select No Override for a setting to use the default setting configured for the merchant.

      • Set Signature Threshold Amount - Specify the minimum transaction amount at which the merchant will request the cardholder's signature. Leave this field blank to use the default setting configured in the Clover Dashboard.
      • Auto-print receipt - Specify whether or not a receipt should be automatically printed for every transaction.
      • Enable Tipping On Gateway - Specify whether or not merchants using this profile should be enabled to accept tips.
      • Tipping - Specify whether or not the merchant is enabled to request a tip amount. Requires Enable Tipping on Gateway.
      • Tip on Paper - When tipping is enabled, whether or not the receipt should include a tip section for the cardholder to specify and sign for a tip amount. Requires Enable Tipping on Gateway.
  6. Click Create Profile.

The profile is now displayed on the Apps & Settings tab, and is available to select when creating an application template or submitting a merchant application.

Creating Application Templates

Application templates allow you to pre-populate the merchant application with specific, pre-determined details (for example, a profile) that apply to some or all of your merchants.

Your account manager may have already created an application template to get you started; check the Application Templates tab on your Dashboard. 

If you are using the CoPilot API to submit and manage merchants, you must create at least one application template and specify the template ID in your merchant create requests.

To create an application template, do the following:

  1. Click Dashboard in the left pane to access your Dashboard.
  2. On the dashboard, select the Application Templates tab.
  3. Click New Template.
  4. In the Template Name field, enter a meaningful name for this template. For example, "Restaurant Template" if this is a template that you plan to use for all restaurant merchant applications.
  5. In the Account Type field, select Merchant Services.
  6. In the Sales Code field, enter your sales code.
  7. Click Save to create the new template.
  8. On the Template page, click Template Detail in the left pane.
  9. Select the Equipment tab.
  10. On the Equipment page, remove the CardPointe Gateway by clicking Remove. This prevents CoPilot from boarding your merchants to both the Clover and CardPointe Gateways.
  11. Optionally, click Choose Equipment to add Clover equipment to this template.
  12. Complete the remaining fields on your template as applicable for your merchants, then click Save, when finished, to complete the application template.

For more information on application templates, see the CoPilot User's Guide.

Ordering Clover Devices

When you order a Clover device for a new merchant, CoPilot automatically boards the merchant to the Clover Gateway.

The Clover Profile associated with the merchant ensures that your applications and merchant settings are pre-configured for a seamless out-of-box experience for your merchant.

For merchants using a card-present integration (for example, using the REST Pay Display API), order Clover devices like the Clover Mini LTE & WiFi to board your merchants to the Clover Gateway and ship the pre-provisioned devices.

For merchants using a card-not present integration (for example the Ecommerce API and iFrame), order the Clover Gateway Only option to board the merchant to the Clover Gateway.

To order equipment, do the following:

  1. Search for and select a customer.
  2. On the Account Summary page, click Orders in the left pane.
  3. Click the New Order button. 
  4. On the CardConnect Endorsed Equipment tab, browse to the Clover device (or the Clover Gateway Only option for card-not-present integrations) that you want to order, and click Order.
  5. On the New Order dialog, complete the fields in the Details, Payments, and Shipping tabs, then click Save Order.
  6. On the Orders page, click Submit All New Orders.
  7. If this merchant is not already associated with a Clover Profile, select the profile that includes the apps and settings for this merchant.

For more information on ordering equipment and tracking open orders, see the CoPilot User's Guide.

Managing Clover Devices 

CoPilot offers a range of features for managing your merchants' Clover devices, including:

  • Remote Device Support - Remote directly into your merchants' device to assist with troubleshooting, and review and push app updates.

  • Clover Promotions - Display custom messages on your merchants' devices. 

  • Provisioning Device Management - Re-associate devices from one merchant account to another.

To get started, select the Devices subtab from your Clover Partner Dashboard.

See the CoPilot Clover Integration User's Guide for more information on managing your merchants' devices in CoPilot.