Skip to main content

Clover Installation Instructions

Step-by-step guide to subscribing to, authorizing (OAuth), and configuring the Clover integration in iPaaS.com, including the subscription settings.

This document walks you through subscribing to the Clover integration from the Certified Integration Marketplace, authorizing the connection to your Clover merchant account, and completing the subscription settings so data can flow between Clover and iPaaS.com.

Before You Begin

The Clover integration connects to your Clover merchant account using OAuth authorization. During setup you will authorize the iPaaS.com Clover app against your Clover account, and Clover will grant an access token that iPaaS.com stores as the API Key subscription setting. You do not need to generate or paste this token by hand when the OAuth flow is used — authorizing the app captures it for you.

To complete authorization and configuration you will need the following. Gather what applies to your account before you begin:

  • Client Id and Client Secret: issued by Clover for the iPaaS.com app registration. These are supplied in the subscription's custom fields and identify the app during OAuth. See Clover's OAuth documentation for how these credentials are used: Clover OAuth flow overview (accessed 2026-07-06).

  • Merchant ID: identifies your specific Clover merchant account. It is captured during the OAuth authorization step and also appears at the end of your Clover administrative URL when you are logged in.

  • Employee Id: the employee recorded on transactions uploaded to Clover by iPaaS.com. It is captured during authorization; you can also retrieve it from Clover under Account & Setup > Employees > Employees.

  • Order Type Id: an alphanumeric code identifying the order category applied to transactions written to Clover. Retrieve it from Account & Setup > Transactions > Order Types (edit an order type and read the code from the browser URL).

  • Order Tax Id: the tax type applied to transaction lines written to Clover. Tax IDs are not shown in the Clover administrative interface; retrieve the value from your Clover tax-rate list as directed by Clover.

Note: Under the OAuth authorization flow, the Merchant ID and Employee Id are captured for you when you authorize the Clover app. The steps above are provided so you can locate these values in Clover if you need to confirm or re-enter them.

Installation Instructions for Integration Setup

  1. Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe. ​

  2. Click the Clover integration title. ​

  3. On the Subscription Detail page, click the Subscribe button.

  4. Enter a name for the subscription. It can be any relevant and unique subscription name within the company where this subscription is created.

    • Format: [Product Name] - [Environment/Purpose]

    • Example: Clover - Production

  5. Select a Version from the drop-down.

  6. Select Create Default Mappings (recommended). This provisions the standard Clover mapping collections so you can begin syncing without building every mapping by hand. If you would rather build all mappings from scratch yourself, uncheck this box. ​

  7. Complete the subscription settings described in the next two sections (Authentication Configuration and the settings table), then click Apply to save.

API Endpoint and Environment URL

The Environment URL is the Clover base URL the subscription targets. Clover maintains separate base URLs for its sandbox (developer/test) and production environments, so enter the URL that matches the Clover account you are connecting to:

Environment URL: the Clover base URL for your account.

  • Test/Sandbox: https://apisandbox.dev.clover.com

  • Production: https://api.clover.com (North America). Clover uses region-specific production base URLs — for example, https://api.eu.clover.com for Europe and https://api.la.clover.com for Latin America.

Clover documents the sandbox versus production base URLs on its developer site: Clover developer environments (accessed 2026-07-06). Confirm the correct base URL for your Clover account and region before saving.

Throttling and Concurrency

These settings protect system performance and ensure fair usage by limiting how many API requests the integration issues in a given window. The defaults below are appropriate for most subscriptions.

Setting

Purpose

Default

Recommended / Range

API Throttle Limit

Maximum number of API requests allowed within the throttle window. Prevents any single integration from overwhelming the system.

See recommended

Initial Setup: 5; Ongoing Operations: 500; High Volume: 500

API Throttle Seconds

The time window over which the throttle limit is measured. Requests beyond the limit are rejected until the window resets.

60 seconds

60 seconds

Concurrent Connections

Maximum number of simultaneous API connections. Excess requests are queued or rejected until an active connection finishes.

5

Up to 10

Concurrent Batch Executions

Maximum number of simultaneous batch executions for the integration. Excess requests are queued or rejected until an active execution finishes.

5

Up to 10

Authentication Configuration

The Clover integration authenticates using OAuth 2.0. You authorize the iPaaS.com Clover app against your Clover merchant account; Clover then issues an access token that iPaaS.com stores as the API Key setting and uses on every request. Clover access tokens have a defined lifespan, so the integration relies on the authorized app grant rather than a manually pasted, permanent key.

OAuth Authorization Flow

  1. Begin the subscription setup as described above and start the Clover authorization step.

  2. iPaaS.com redirects you to Clover's authorization server using the app's Client Id.

  3. Sign in to your Clover merchant account and grant the requested permissions.

  4. Clover returns an authorization code to iPaaS.com, which exchanges it — together with the Client Id and Client Secret — for an access token.

  5. iPaaS.com stores the access token as the API Key setting and captures the Merchant ID and Employee Id for the subscription.

Clover documents this authorization-code flow (redirect for merchant consent, then exchange of the code plus Client Id and Client Secret for an access token) on its developer site: Clover OAuth flow overview (accessed 2026-07-06).

Credential Reference

Credential

Location in Clover

Description

Client Id

Supplied in the subscription's custom fields (issued by Clover for the iPaaS.com app).

Identifies the iPaaS.com app to Clover during the OAuth authorization request.

Client Secret

Supplied in the subscription's custom fields (issued by Clover for the iPaaS.com app).

Held securely and used with the Client Id to exchange the authorization code for an access token.

Merchant ID

Captured during OAuth authorization; also visible at the end of your Clover administrative URL.

Identifies your specific Clover merchant account.

Employee Id

Captured during OAuth authorization; also under Account & Setup > Employees > Employees.

The employee recorded on transactions iPaaS.com uploads to Clover.

Important Notes:

  • Clover access tokens expire; the OAuth grant lets the integration continue operating without you re-pasting a token on every expiry. If the connection stops authenticating, re-authorize the Clover app from the subscription.

  • The Client Id and Client Secret are entered in the subscription's custom fields, not in the standard settings table. Keep the Client Secret confidential.

Subscription Settings

Enter the following seven settings on the Subscription Settings page. Environment URL, Merchant ID, and API Key are populated or confirmed as part of the OAuth authorization flow described above; Employee Id, Order Type Id, Order Tax Id, and DeleteAndRecreate control transaction and product behavior.

Setting

Description

Environment URL

The Clover base URL for your account (sandbox or production/region). See API Endpoint and Environment URL above.

Merchant ID

Identifies your Clover merchant account. Captured during OAuth authorization.

API Key

The Clover OAuth access token. Populated by the OAuth authorization flow.

Employee Id

The employee recorded on transactions uploaded to Clover. Captured during authorization; also retrievable from Clover.

Order Type Id

The order category applied to transactions written to Clover. Retrieve from Account & Setup > Transactions > Order Types.

Order Tax Id

The tax type applied to transaction lines written to Clover. Retrieve from your Clover tax-rate list.

DeleteAndRecreate

Controls how the integration handles converting a simple product into a variant product in Clover. See below.

DeleteAndRecreate values:

  • True: When converting a simple product to a variant product, the integration deletes the existing item in Clover and recreates it as a new item group before proceeding with the update.

  • False: The integration does not delete and recreate; instead it stops the update with an error, acting as a safeguard so products are not re-created unexpectedly.

After entering all settings, click Apply to save the subscription.

How Clover Data Is Captured

Automatic capture of new and updated transactions from Clover into iPaaS.com is performed by transaction polling: the integration polls Clover for new and updated transactions on its schedule. There is no subscriber-configured webhook on the Clover side — you do not need to register or maintain a webhook endpoint in Clover for automatic capture to work. Customers are carried into iPaaS.com as part of a transaction (a customer must exist on the transaction to transfer with it), and a Manual Sync is always available on demand.

Post-Installation Verification

After completing the installation, perform these tests to verify the setup:

Connection Test

  1. Confirm the subscription saved without an authentication error after clicking Apply.

  2. If authentication fails, re-run the OAuth authorization for the Clover app and confirm the Environment URL matches your Clover account's environment and region.

Data Sync Test

  1. Initiate a sample data pull (to iPaaS.com).

  2. Initiate a sample data push (from iPaaS.com).

Functionality Test

  1. Run an end-to-end business process.

  2. Validate key features such as field mappings, workflow triggers, and logging.

  3. Review integration logs in iPaaS.com under Dashboard / Integration Monitoring / Error Logs.

Support and Troubleshooting

Click the Help button on any iPaaS.com page to contact Support or to search our documentation.

Did this answer your question?