Platform Docs

When will my app be approved for Clover merchants?

See Clover app approval process. Also, note that apps must pass the Clover functional review playbook.

My Devkit device is offline but it is connected to the internet. Why is this happening?

You can find the answer to this question on Community.

My Devkit device is stuck at "Error retrieving merchant information" during activation. Why is this happening?

You can find the answer to this question on Community.

My Mini 1 device is unresponsive after the power is cycled. How can I fix it?

You can find the answer to this question on Community.

How can I set up an emulator for developing and testing my app in sandbox?

See Emulator Setup in Android Studio.

What is the merchant ID? How does it relate to the employee ID?

The merchant ID is an ID assigned by Clover to the business. A business may have multiple devices and employees. The owner of the business (along with managers and employees) each have an employee_id associated with their account. When looking at the OAuth response, keep in mind that you can see who the current user is by using the employee_id. You can use the merchant_id to see which business the user belongs. You must use themerchant_id when making REST API calls.

When do I use an OAuth API Token, a merchant API Token, and my App Secret?

For production apps, developers should use an API token that is generated via OAuth. This token gives a particular app access to the Clover API for a specific merchant. Remember to use the App Secret when using the authorization code method of OAuth. For testing purposes only, it is possible to get a merchant API Token for your test merchant via the Setup App.

How can I get the merchant ID and a merchant API Token for my own test merchant?

This video demonstrates how to get the merchant ID and a basic merchant API Token for your own test merchant for use in development and testing. We strongly recommend that any production Clover app use OAuth API Tokens.

Where can I get an API token for a particular merchant account without creating an app and having the merchant install the app?

Please refer to our guide on creating test Merchant API tokens. Note that these API tokens should only be used for testing and development purposes. Production apps must programmatically generate API tokens through OAuth or the Android SDK.

How long do API tokens last?

An API token has a lifespan of 1 year.

How can my app differentiate between real merchants and test merchants?

If you have a paid app, you may want to know whether you can bill a given merchant. For example, test merchant accounts used by developers and salespeople are not billable, so you will not get paid if apps installed for these types of accounts.

GET to /v3/merchants/{mId} to get merchant info, including an isBillable property.

How can my app differentiate between owners, managers, and employees?

If your app has the EMPLOYEE_R permission, then you can fetch information about the current user via a GET to /v3/merchants/{mId}/employees/{employeeId}?expand=roles. This will give you information about the role of the current user. If your app has the MERCHANT_R permission, then you can fetch the information about the owner via a GET to /v3/merchants/{mId}?expand=owner.

How do I use the Web API (V3 REST API) to create an order?

You can find detailed instructions for building an order with the REST API here.

How do I use the Web API to pay for an order?

Please see our documentation for the Developer Pay API.

How do I notify a merchant of important changes?

You can notify your Android app running on the Clover devices via App Notifications. Once your app launches you can show a notification in the Android notification area, launch a Clover app via Broadcasts & Intents, or launch your own Activity.

I've set up my app using Create App on the Developer Dashboard using. Why am I unable to view my app settings on the side-nav?

Once you set up apps on the Developer Dashboard, you can view all your app settings on the side-nav. To view settings for an app, click the app on the side-nav. To view all your apps on the side-nav, click YOUR APPS at the top of the side-nav.

What are the test card numbers I can use for declines and partial transactions?

See Test Card Numbers

How do I get my magnetic stripe card BIN whitelisted?

As a security measure, Clover follows an encryption-by-default model for magnetic stripe cards and does not whitelist Bank/Issuer Identification Numbers (BINs) for magnetic stripe cards in the US. However, depending on the Clover devices you are building your app for and the type of card you are using, you can retrieve unencrypted track data without any whitelisting required.

Clover defines a financial card as one that:

  • has either track 1 or track 2 data that conforms to ISO/IEC 7813:2006, and
  • the Primary Account Number (PAN) on the track has 12 or more characters

On Clover Station (2018), Mini (1st and 2nd generation), Flex, and Mobile, you can simply swipe a non-financial card, such as a gift card, and retrieve unencrypted track data without any whitelisting required. On Clover Station, non-financial cards cannot be read.

NOTE

We highly recommend gift card developers to use QR codes for reading physical cards using the merchant-facing camera on Clover devices. Also, many Clover devices support NFC for reading digital cards.

Are gift cards supported by the E-Commerce API?

Open-loop gift cards—cards which are associated with a major card brand like Visa, Mastercard, American Express, or Discover—can be tokenized and processed like a normal credit card. Closed-loop gift cards, those issued by and redeemable at a single merchant or retailer, cannot be used for E-Commerce transactions.

Why does my YouTube or Vimeo video not play on the More Tools app on my Clover device?

Certain Clover devices have limitations on the video codecs they support. This affects how videos are played in Clover App Market on these devices:

  • Clover Station 2018 and Mini (2nd generation) support YouTube and Vimeo
  • Clover Station and Mini (1st generation) support only YouTube
  • Clover Flex supports only Vimeo

Depending on the Clover devices you are building your apps for, we recommend that you keep these limitations in mind. Note that the Web version of Clover App Market has no such limitations.

What SSL/TLS cipher suites should my app support?

All Clover devices and servers follow industry best practices for SSL/TLS configuration. To ensure interoperability, you must ensure that your servers use a compatible SSL/TLS configuration.

SSL/TLS versions: Clover devices and servers are only guaranteed to support TLS 1.2. Some devices and servers may support TLS 1.1 and TLS 1.0. For security reasons, SSL 3.0 is not supported.

Cipher suites: Clover devices and servers are guaranteed to support the following cipher suites:

  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384

Additional cipher suites may be supported on some servers and device models. For security reasons, ciphers using HMAC-MD5, RC4, or single key DES are not supported.

Certificate signatures: Use only SHA2 signed certificates with at least 2048 bit RSA keys.

NOTE

Clover guarantees support only for the above TLS versions and cipher suites. Alternative configurations may be supported by some devices and servers, but support may be removed at any time.

For example, some cipher suites supported on Clover Station are not supported on Clover Mini, but Clover may remove support for these cipher suites at any time.

More Questions?

Please ask your question on Clover Developer Community.

Updated 11 days ago


FAQs


Suggested Edits are limited on API Reference Pages

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