The following guide covers the prerequisites and steps to set up and use Insight Works’ payment provider integration extension for Clover in Counter Sales.
Prerequisites
Before you begin, ensure you have the following:
- An active Clover account; contact Clover to obtain one.
- Your Merchant ID and account credentials provided by Clover.
- If using a Clover sandbox environment, the Client ID and Client Secret for your sandbox developer app from the Clover Developer Portal.
- The Clover Counter Sales Payment Provider app installed in your Business Central environment. If you do not have the app, contact Insight Works to request the file.
Set up Clover
- Navigate to the Counter Sales Payment Provider Configurations page in Business Central (for more information on setting up and using Payment Provider Configurations, see the Payment Provider Configurations in Counter Sales page).
- Select New and enter the following in the General section:
- Code: A unique name to identify this Payment Provider Configuration (e.g., CLOVER).
- Type: Clover (if you do not see Clover in the dropdown, ensure the Insight Works app is installed).
- Select Actions / Clover / Initialize (populates the configuration with default settings, including the URLs required to communicate with Clover).
- Select your environment (a confirmation message will appear if initialization is successful; you can update the Description field at any time):
- Sandbox: Requires you to enter the Client ID and Client Secret for your sandbox developer app.
- Production: Automatically sets the Client ID and Client Secret for the Insight Works’ Clover app.
- Locate the Connection Details section and enter the credentials provided by Clover (fields are masked for security purposes):
- User ID: Your Clover Merchant ID.
- Client ID: For a sandbox environment, use the Client ID for your developer app; for a production environment, this is set to the Insight Works Clover app by the Initialize action.
- Client Secret: For a sandbox environment, use the Client Secret for your developer app; for a production environment, this is set to the Insight Works Clover app by the Initialize action.
- Locate the Payment & Card Details section and set the Payment Method Code field (cannot be blank) to the payment method code to be applied to the payment line created by each Clover transaction (any payment methods configured in your payment networks take priority over this value).
- Select Actions / Clover / Authenticate (Clover uses OAuth 2.0 to securely communicate with their services; ensure popups are enabled).
- Log into Clover in the new browser window with your merchant account (as applicable if you have multiple) credentials and grant the app access when prompted (you are redirected back to Business Central and a message indicates the access token and refresh token were successfully received).
- Close the new browser window.
- Select Test Connection (a confirmation message indicates whether the connection to Clover was successful; if the test fails, confirm your credentials are entered correctly and Initialize again to reset the URL fields to their default values and run the Authenticate action again to ensure your access token is valid).
- Register each physical Clover device, if you are using payment terminals, before it can be used:
- Select Related / Terminals (opens the Counter Sales Payment Provider Terminals page for the current configuration).
- Select New and enter the following:
- Code: A unique name to identify this terminal.
- Serial No.: The serial number of the physical Clover device, found on the device itself or in the Clover Dashboard.
- Close the card page to save the terminal.
- Repeat step 11 to register additional terminals.
- Set the unique Clover identifier code for each network if you are using Payment Networks:
- Select Related / Payment Networks (opens the Counter Sales Payment Networks page; ensure the list is populated).
- Select Actions / Clover / Set Identifier Code (you are prompted to select which area(s) to update).
- Select OK (a message indicates whether the update was successful).
For more information on setting up and using Payment Networks, see the Payment Networks in Counter Sales page.
Notes
- For account setup or missing credentials, contact Clover support directly.
- For installation of the Counter Sales Payment Provider integration app, contact Insight Works.
- The Clover integration caches the Payment Provider Configuration settings for each user session to improve performance. If changes are made to the configuration, all users currently logged into Business Central must log out and back in for the updates. Alternatively, users can select Actions / Clover / Clear Current Session Configuration, available on both the list and card pages.
Payment Provider configuration: Clover field reference
The following fields are required for Clover integration. URL fields are automatically populated when you select Initialize and do not need to be changed under normal circumstances.
| Pitch | Required | Description | Expected / Default Value |
| Code | Mandatory | A unique code to identify this configuration. | User-defined (e.g., CLOVER) |
| Type | Mandatory | Determines the payment provider used by this configuration. | Clover |
| User Id | Mandatory | Your Merchant ID. | Provided by Clover |
| Client Id | Mandatory | The client id for the Clover app to communicate with their services. | Clover sandbox: Your sandbox developer app Clover production: Insight Works app |
| Client Secret | Mandatory | The client secret for the client id. | Clover sandbox: Your sandbox developer app Clover production: Insight Works app |
| URL 1 | Mandatory | URL for OAuth2 authorization, Merchant API, and Terminal REST Pay. Set automatically by the Initialize action. |
Clover sandbox: https://sandbox.dev.clover.com Clover production: https://www.clover.com |
| URL 2 | Mandatory | URL for eCommerce charges, voids, customer/card management. Set automatically by the Initialize action. |
Clover sandbox: https://scl-sandbox.dev.clover.com Clover production: https://scl.clover.com |
| URL 3 | Mandatory | URL for OAuth token exchange and refresh. Set automatically by the Initialize action. |
Clover sandbox: https://apisandbox.dev.clover.com Clover production: https://api.clover.com |
| URL 4 | Required for card not present transactions | URL for checkout SDK JavaScript library for manual card entry iframe integration. Set automatically by the Initialize action. |
Clover sandbox: https://checkout.sandbox.dev.clover.com/sdk.js Clover production: https://checkout.clover.com/sdk.js |
| Payment Method Code | Mandatory | The default payment method code applied to the payment line created by a Clover transaction. | User-defined |
| Clover Payment Behavior | Mandatory | Controls how the payment request is sent to Clover. System Default uses standard Counter Sales business logic. Authorize reserves the payment amount on the customer’s card without capturing. Capture authorizes and collects the payment in a single step. | System Default |
| Clover Signature Request | Required for signature capture | Controls whether the customer’s signature is automatically captured. | None |
| Clover Custom Redirect URL | Optional | Custom redirect URL for the Clover payment provider callback. Only required when your environment is not publicly accessible from the internet, such as during local or Docker-based testing. | User-defined |
| Clover Token Expiration | Information | The expiration date and time of the access token. | System-defined |
| Clover Refresh Token Expiration | Information | The expiration date and time of the refresh token. | System-defined |
| Clover Override Currency Code | Optional | The currency code to override the local currency configured in the General Ledger Setup when communicating with Clover. Typically used during testing when the Business Central environment and Clover sandbox are configured in different currencies. | User-defined |
Payment Networks: Clover Identifier Code reference
The following Identifier Codes are assigned by Clover to each supported payment network. These codes are used to identify the card brand associated with a transaction.
| Payment Network | Clover Identifier Code |
| Visa | VISA |
| Mastercard | MC |
| American Express | AMEX |
| Discover | DISCOVER |
| Diners Club | DINERS_CLUB |
| JCB | JCB |
Still need help?
Ask other Business Central users in the Insight Works community, or send the details to the support team. Include the steps you took and any error message you saw.