Platform Docs

Clover DevKits

Overview

Clover Developer Kits (Dev Kits) are Clover devices with special permissions that can simulate transactions in a sandbox environment. This environment is completely separate from the production environment.

The sandbox environment allows you to test apps in preparation for later deployment on the production server. A Dev Kit enables you to experience transactions end-to-end from both the merchant and customer perspectives.

A Clover Dev Kit can run unpublished apps and allows connections with Android Debug Bridge (ADB). A device is a development model if the Android Settings app on the device includes a Developer options sub-menu.

Ordering a Dev Kit

Dev Kits can be ordered from cloverdevkit.com.

NOTE

Dev Kits can only be shipped directly to US addresses. Developers outside the US must use a package forwarding service to ship Dev Kits to their final destination.

Once you've placed your order and received your Dev Kit, familiarize yourself with the hardware by reviewing the accompanying guide. The guide is also available on the Clover Help site. Then, follow the steps below to set up your Dev Kit for use with your sandbox development account.

IMPORTANT

Repeatedly inserting an active EMV credit card into an EMV-enabled development device that is pointed to a blackhole payment gateway may result in the credit card disabling itself. This is due to EMV protections against repeated inserts that do not result in actual payments.

IMPORTANT

You cannot re-provision your Dev Kit between the sandbox and production environments. In addition, you cannot migrate your developer and merchant accounts between the sandbox and production environments.

Associating your Dev Kit

NOTE

Clover Go Dev Kits do not need to be associated with a merchant account.

After setting up your Clover sandbox account, you can associate your Clover Dev Kit with your test merchant account:

  1. Unbox and power on your Dev Kit.
  2. On the sandbox Developer Dashboard, click Dev Kits on the side-nav.
  3. On the Dev Kits page, click ASSOCIATE DEV KIT.
  4. On the Associate Dev Kit modal that appears, enter the serial number for your development kit found on the sticker attached to your Dev Kit's box (for example, C012UQ12345678).
  5. Select your test merchant account from the Test Merchant list.
  6. Click Associate Dev Kit. An activation code appears. Clover also sends you an email with a code to your development account. You will need this code to activate your DevKit.

IMPORTANT

If the activation process is not completed within 30 minutes, Clover will disable the activation token, and you will need to begin the association process again.

Activating your Dev Kit

After you've associated your Dev Kit, complete the setup and activation steps for your Dev Kit.

NOTE

The Clover Flex Dev Kit includes a hub with ports for power, USB type B, and Ethernet to aid in development and testing. This hub replaces the charging cradle that is shipped with merchant devices.

NOTE

As part of your on-screen Dev Kit setup, you are not charged for selecting a merchant service plan.

The activation process takes a few minutes. Once the Dev Kit is activated, you see an update on the Dev Kits page on the Developer Dashboard.

Reassociating or disassociating your Dev Kit

As part of your app development in sandbox, you can create multiple test merchants with different configurations. To reassociate your Dev Kit with another test merchant:

  1. On the sandbox Developer Dashboard, click Dev Kits on the side-nav.
  2. On the Dev Kits page, click Reassociate Dev Kit from the overflow menu of your associated Dev Kit.
  3. On the Reassociate Dev Kit modal that appears, select the new test merchant from the Test Merchant list.
  4. Click Reassociate Dev Kit. An activation code appears. Clover also sends you an email with a code to your development account. You will need this code to activate your DevKit.
  5. Complete the process of activating the Dev Kit for the new test merchant account.

To disassociate your Dev Kit:

  1. On the sandbox Developer Dashboard, click Dev Kits on the side-nav.
  2. On the Dev Kits page, click Disassociate Dev Kit from the overflow menu of your associated Dev Kit.
  3. On the Disassociate Dev Kit modal that appears, click Disassociate Dev Kit. The Dev Kit is disassociated. You can associate your Dev Kit with another test merchant account.

Enabling Android Debug Bridge

Android Debug Bridge (ABD) allows you to debug your Clover application using a USB or Wi-Fi connection.

IMPORTANT

Sandbox Clover Station cannot be connected for debugging over USB. In order to use ADB with a sandbox Clover Station, connect via Wi-Fi. Clover Station has the TCP/IP port set to 5555.

  1. Using a text editor, open the adb_usb.ini file.
    • On OS X, this file is located at ~/.android/.
    • On Windows, this file is located at C:\Users\[username]\.android.
  2. Add a new line with the value 0x28f3. Your adb_usb.ini file should look similar to the following:
  3. Save and close the file.
# ANDROID 3RD PARTY USB VENDOR ID LIST -- DO NOT EDIT.
# USE 'android update adb' TO GENERATE.
# 1 USB VENDOR ID PER LINE.
0x28f3 #clover vendor id

ADB over USB

You can use Android Debug Bridge (ADB) to access your Dev Kit directly using a USB A-to-USB B cable. To connect your computer and the Dev Kit, complete the following steps.

  1. Connect the USB A end of the cable to your computer.
  2. Connect the other end of the cable to your Dev Kit:
    • For Clover Flex and Mini, connect the USB B end of the cable to the hub.
    • For Clover Mobile, connect the Micro USB end of the cable to the port at the bottom of the handle (this is the same port used to connect the Dev Kit to the USB wall charger).
    • For Clover Station 2018, connect the Micro USB end of the cable to the debugging port as shown in this video.
  3. In Android Studio, select View > Tool Windows > Terminal (Alt+F12/Option+F12) and run adb devices. Your Dev Kit's ID (a fourteen-character alphanumeric value) is returned.

NOTE

Some Windows users have experienced issues with their computers not recognizing their Dev Kits after following the steps above.

If this occurs, try force-installing the Samsung ADB Driver. For more information, see how to force install a driver.

ADB over Wi-Fi

Once you've configured your computer to recognize the Dev Kit using ADB, you can connect to the device over Wi-Fi. Follow the steps for a standard Android device.

NOTE

You must disconnect or disable any ethernet network connection on your Dev Kit for the device to fall back to Wi-Fi, which then enables wireless debugging.

If you encounter issues with your Clover Dev Kit, please refer to the Dev Kits FAQs.


Clover DevKits


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.