Region-specific features and limitations
Clover supports developers in markets around the world. The Clover open platform provides tools for developers to design, configure, test, and manage app integrations for Clover merchants. You can use different environments based on specific regions. For more information, see Use Clover developer environments.
In the Clover developer environments, different integrations are available across various regions. Use the decision tree to select an integration and integration tools.
Clover integrations overview
Clover offers a variety of integrations to support developers across different regions. Here's a summary of the various types of integrations:
| Integration types | Description |
|---|---|
| On-Clover device integration | Uses the Android SDK and lets you build apps that run on Clover devices. It is also used for semi-integration with a Clover device, enabling a third-party point of sale (POS) system to use Clover for processing payments. |
| Online integration | Uses the Ecommerce API and the REST API. The Ecommerce API lets you integrate Clover payment capabilities into your online or web-based applications. The REST API lets you build a browser-based integration that creates a secure connection to your website. |
| Online integration and semi-integration | Uses the REST Pay Display API, which lets POS applications accept payments on Clover Flex or Clover Mini devices. Your apps can connect to Clover devices using cloud or local network connections without needing an embedded software development kit (SDK). |
| Payment integration and semi-integration | This integration uses the Android Payment API, Clover Connector SDK, and Payment Connector. These tools allow for a wide range of payment operations, from basic transactions to more complex functions like preauthorizations and reversals. They also provide the flexibility to build a POS system directly on a Clover device or integrate with external POS systems. |
Integrations and tools across regions
This table provides information on the regions in which the integrations and related tools are available.
| Integration | Tools | Description | Region |
|---|---|---|---|
| On-Clover device integration | Android SDK | The Clover Android SDK lets you build apps that run on Clover devices and publish your apps on the Clover App Market. It is also used for semi-integration with a Clover device, enabling a third-party point of sale (POS) system to use Clover for processing payments. | North America Europe Latin America |
| Online integration | Ecommerce API | The Ecommerce API lets you integrate Clover payment capabilities into your online or web-based applications. It provides endpoints for creating tokens, processing payments, and managing customer data. OAuth tokens are necessary for authentication and authorization. | North America |
| Online integration | REST API | The Clover REST API lets you build a browser-based integration that creates a secure connection to your website. It redirects a merchant from the Clover Merchant Dashboard to your website URL (link). | North America Europe Latin America |
| Online integration and semi-integration | REST Pay Display API | The REST Pay Display API lets point of sale (POS) applications accept payments on Clover Flex or Clover Mini devices. Your apps can connect to Clover devices using cloud or local network connections without needing an embedded software development kit (SDK). | North America Europe |
| Payment integration and semi-integration | Android Payment API | The Android Payment API is an intent-based API used in applications running on Clover devices to execute payment transaction requests. It supports payment operations, including payments, preauthorizations, and payment reversals (void/refund), using Android Intent Builders. | United States |
| Payment integration and semi-integration | Clover Connector SDK | The Clover Connector SDK provides an interface that lets external point of sale (POS) systems access the same payment functions as PaymentConnector, such as sales and refunds. It also offers additional features like custom receipts and Android activities. This SDK is available for four platforms: Android, iOS, JavaScript, and .NET. | North America Europe Latin America |
| Payment integration and semi-integration | Payment Connector | The Payment Connector is a Java-based interface that lets you build a point of sale (POS) directly on a Clover device. It provides all of the Clover features needed for your app to make a sale, issue a refund, and perform other payment functions. | North America Europe Latin America |
| Bring your own device (BYOD) integration | Clover Go SDK | The Clover Go software development kit (SDK) lets you integrate your Android or iOS apps with the Clover Go reader. | United States |
In this Clover developer documentation portal (docs.clover.com), use the green Regions icon at the top of each topic page to identify if a topic and its content are relevant to your region.
Transaction methods
Overview
Clover also supports various transaction methods for specific purposes and functionality in the payment process. The following table provides information for on-device transaction methods.
| Transaction method | Description |
|---|---|
| Sale | Customer transaction where the purchase amount is authorized and settled at the same time. The customer can add a tip amount only before the transaction is authorized and settled. If a sale is not voided within 25 minutes, the merchant funding process begins for this sale. |
| Auth | Customer transaction where the purchase amount is authorized and then tip-adjusted even after the transaction is authorized. |
| Partial Auth | Process that provides an option for customers who lack sufficient funds or credit in their accounts to complete a purchase with a business. If a payment intent is launched and the Clover device accepts a card, it returns a partial approval of the bill. Example: If the bill is $100 and the customer has $50 on their card, $50 is charged to the customer, and $50 is still owed. The business must then either void that $50 charge or get $50 more from the customer. |
| Capture Pre-auth | Process of finalizing a pre-authorization by capturing the final amount. |
| Void payment | Void cancels a sale, but the void must occur within 25 minutes of the original transaction. After that time elapses, the merchant can only refund the customer because the funding process has started. If a void is attempted after 25 minutes, Clover processes it as a refund. |
| Payment refund | Process of returning some or all of a payment amount to the cardholder. |
| Manual refund | Partial or complete repayment to a customer for a specific order, usually due to a transaction void or refund. |
| Vault card | Clover Payment Connector SDK, and Ecommerce API provide functions to capture an encrypted card token and store or vault it for later use. This lets your merchants process recurring payments or complete in-person transactions more quickly for returning customers. |
| Manual closeout | Process of closing out all captured (Auth payments) transactions. |
| Read card data | Process of initiating a read card operation on a Clover device and returning the card track data. |
Transaction methods: Regions matrix
The following tables display transaction methods available for merchants in specific International markets.
| Country | Sale | Auth | Partial Auth | Pre-auth | Capture Pre-auth | Void payment | Payment refund | Manual refund | Vault card | Manual closeout | Read card data |
|---|---|---|---|---|---|---|---|---|---|---|---|
| North America | |||||||||||
| United States | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Canada | ✅ * | ✅ * | ✅ | ✅ * | ✅ | ✅ * | ✅ | ||||
| Europe | |||||||||||
| Austria | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ||||
| Germany | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ||||
| Ireland | ✅ | ✅ | ✅ | ✅ | ✅ | ||||||
| Netherlands | ✅ | ✅ | ✅ | ✅ | |||||||
| United Kingdom | ✅ | ✅ | ✅ | ✅ | ✅ | ||||||
| Latin America | |||||||||||
| Argentina | ✅ | ✅ | ✅ | ✅ |
Note: See information on using Interac cards for interactions indicated with an asterisk * in the Canada region.
Transaction methods: Regional support and limitations
The transaction methods may include support for additional card networks or restrictions on actions allowed in specific regions, as shown in the following tables:
North America—Canada and the United States
Interac transactions are limited by the SDK to specific payment actions. This is to conform with the network's rules for personal identification number (PIN) entry.
Integrations for United States (US) merchants can use all methods provided by the ICloverConnector interface.
| Method | Regional support and limitations |
|---|---|
| Sale | Only credit cards and co-branded Interac cards can be entered manually when processing a transaction using the sale() method. |
| Auth and pre-auth | Not supported: - Transaction methods: auth() and preAuth()- Tip adjustments: tipAdjustAuth() |
| Payment refund and void | Supported: To refund an Interac transaction using the refundPayment() method, the card must be inserted into the Clover device.Not supported: Voiding of refunds is not supported. |
| Vault card | Not supported. Interac cards cannot be stored for future transactions using the vaultCard() method. |
| Offline payment | Not supported. Canadian merchants cannot use their Clover devices to process any payments in offline mode. |
| Manual closeout | Not supported. Method: closeout(). All merchants are automatically closed out. |
| Currency restrictions | Only merchants configured to process transactions in Canadian dollars (CAD) can accept Interac cards. |
Europe—Austria, Germany, and the Netherlands
To comply with European Union (EU) laws and regulations, the following method is not supported for merchants in Austria, Germany, and the Netherlands.
| Method | Regional limitation |
|---|---|
| Pre-auth | Not supported. Transaction method: preAuth() |
Europe—Ireland and the United Kingdom
To comply with European Union (EU) laws and regulations, the following methods are not supported for merchants in Ireland and the United Kingdom (UK).
| Method | Regional limitation |
|---|---|
| Auth and pre-auth | Not supported: - Transactions methods auth() and preAuth()- Tip adjustments using tipAdjustAuth() |
| Vault card | Not supported. Cards cannot be stored for future transactions using the vaultCard() method. |
| Offline payment | Not supported. Payments are not processed if the Clover device is offline. |
| Manual closeout | Not supported. Method: closeout(). All merchants are automatically closed out. |
Latin America—Argentina
To conform with Argentine payment processing rules, the transaction methods are limited as follows:
| Method | Regional support and limitations |
|---|---|
| Pre-auth | Supported. Transaction method: preAuth() |
| Manual closeout | Supported. Method: closeout(). All merchants are automatically closed out. |
| Manual refund | Not supported. Method: manualRefund().Supported: Only specific payments can be refunded using the refundPayment(). |
| Vault card | Not supported. Cards cannot be stored for future transactions using the vaultCard() method. |
| Offline payment | Supported if allowed by the merchant's device settings or by the user's approval when the transaction occurs. |
| Read card data | Not supported. Card information cannot be retrieved with the readCardData() method. |
Updated 5 months ago