---
title: "Set Up Payment Provider Extension Moneris in Counter Sales"
app: "Counter Sales"
section: "How-to guides"
last_updated: "2026-07-16"
url: "https://insight-works.com/kb/counter-sales/set-up-payment-provider-extension-moneris-in-counter-sales/"
---

# Set Up Payment Provider Extension Moneris in Counter Sales

The following guide covers the prerequisites and steps to set up and use Insight Works’ payment provider integration extension for Moneris in Counter Sales.

### Prerequisites

Before you begin, ensure you have the following:

- An active Moneris account; contact Moneris directly to obtain one.
- Your Merchant ID provided by Moneris.
- The Application ID and Secret for your Client Credentials (OAuth) application. See How to Create Your Moneris Client Credentials (OAuth) Application for instructions.
- If processing card present during transactions, your Store ID, API Key (API Token), and Project Code for each physical terminal device, provided by Moneris.
- If processing card not present during transactions, your Frame ID provided by Moneris.
- The Moneris 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 Moneris

1. 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_](/kb/counter-sales/payment-provider-configurations-in-counter-sales/) page).
2. Select **New** and enter the following in the _General_ section:

   - Code: A unique name to identify this Payment Provider Configuration (e.g., MONERIS).
   - Type: Must be set to Moneris (if you do not see Moneris in the dropdown, ensure the Insight Works app is installed).

 Note: You can create multiple configurations for Moneris. For example, one for a sandbox environment and one for production, or separate configurations for different store locations. Assign each a different code.

1. Select **Actions** / **Moneris** / **Initialize** (populates the configuration with default settings, including the URLs required to communicate with Moneris).
2. Select the applicable environment(a confirmation message will appear if initialization is successful; you can update the _Description_ field at any time):

   - Sandbox: Sets URLs to the Moneris sandbox environment.
   - Production: Sets URLs to the Moneris production environment.
3. Locate the _Connection Details_ section and enter the credentials provided by Moneris (masked for security purposes):

   - API Key: Your API Token for authenticating terminal requests. Required for card present transactions.
   - User ID: Your Moneris Merchant ID.
   - Client ID: The Application ID for your Moneris Client Credentials (OAuth) application.
   - Client Secret: The Secret for your Moneris Client Credentials (OAuth) application.

 Note: The Application ID and Secret are created and maintained in the Moneris Developer Portal. See How to Create Your Moneris Client Credentials (OAuth) Application for instructions.

1. Locate the _Payment & Card Details_ section and set the _Payment Method Code_ (cannot be blank) to the payment method code to be applied to the payment line created by each Moneris transaction (any payment methods configured in your payment networks take priority over this value).
2. Locate the _Moneris_ section and enter the applicable credentials provided by Moneris (information located in the Moneris Merchant Resource Center or Moneris Go Portal):

   - Card Not Present Frame ID: Required for processing card not present transactions (e.g., manually entered cards).
   - Terminal Store ID: Required for processing card present transactions (e.g., terminals).
3. Select **Actions** / **Moneris** / **Request Access Token** (this is a server-to-server exchange; a confirmation message indicates whether the access token was successfully retrieved).

 Note: If the access token expires or transactions start failing, run the Request Access Token action again to retrieve a new one. If the request fails, confirm your credentials are entered correctly, select **Initialize** again to reset the URL fields to their default values, and select **Request Access Token** again. Card present during transactions do not use this token; they authenticate directly using the API Key and Store ID for each terminal transaction request.

1. Select **Test Connection** (a confirmation message indicates whether the connection to Moneris was successful; if the test fails, confirm your credentials are correct and select **Initialize** again to reset the URL fields to their default values and run the Request Access Token action again to ensure your access token is valid).
2. Select  **Related** / **Terminals** if you are using terminals (opens the _Counter Sales Payment Provider Terminals_ page for the current configuration.
3. Select **New** and enter the following:

   - Code: A unique name to identify this terminal.
   - Serial No.: The serial number of the physical Moneris device, found on the device or in the Moneris Go Portal.
   - External Reference: The Project Code for this terminal, provided by Moneris during terminal activation.
4. Close the card page to save the terminal.
5. Repeat steps 10 through 12 to register additional terminals if needed.
6. Set the unique Moneris identifier code for each network if you are using Payment Networks:

   1. Select **Related** / **Payment Networks** (opens the _Counter Sales Payment Networks_ page; ensure the list is populated).
   2. Select **Actions** / **Moneris** / **Set Identifier Code** and select which area(s) to update.
   3. Select **OK** (a confirmation message indicates whether the update was successful).

For more information on setting up and using Payment Networks, refer to the [_Payment Networks in Counter Sales_](/kb/counter-sales/payment-networks-in-counter-sales/) page.

### Notes

- For account setup or missing credentials, contact Moneris support directly.
- For installation of the Counter Sales Payment Provider integration app, contact Insight Works.
- The Moneris 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 to pick up the updates. Alternatively, users can select **Actions** / **Moneris** / **Clear Current Session Configuration**, available on both the list and card pages.

### Create your Moneris Client Credentials (OAuth) application

To securely communicate with Moneris’ services, you will need to create a Client Credentials (OAuth) application in the Moneris Developer Portal. Separate applications are required for Moneris sandbox and production environments.

1. Log into the Moneris Developer Portal.
2. Navigate to the _Access & Credentials_ page.
3. Locate the _Store/Merchant ID_ section and complete the following:

   1. Confirm your Merchant ID and Store ID.
   2. Set the Sandbox/Production toggle to the environment you are creating the application for.
4. Locate the _Client Credentials (OAuth)_ section.
5. Under _New Applications_, enter the following:

   - Application Name: A meaningful name to identify the application (e.g., CounterSalesIntegration).
   - Scope: Select all options.
6. Select **Generate Application**.
7. Open the newly-created application and copy its Application ID.
8. Locate the _Generate New Secret_ section and enter the following:

   - Secret: A meaningful name to identify the secret.
   - Expiry Date: The date you want the secret to expire.
9. Select **Generate Secret**.
10. Locate the _Manage Secrets_ section and copy the application’s Secret.

 Note: If the application’s Secret expires, generate a new secret and update the _Client Secret_ field in the _Payment Provider Configuration_.

### Payment Provider configuration: Moneris field reference

The following fields are required for Moneris integration. URL fields are automatically populated when you select **Initialize** and do not need to be changed under normal circumstances.

| **Field** | **Required** | **Description** | **Expected / Default Value** |
| --- | --- | --- | --- |
| Code | Mandatory | A unique code to identify this configuration. | User-defined (e.g., MONERIS) |
| Type | Mandatory | Determines the payment provider used by this configuration. | Moneris |
| API Key | Required for card present transactions | Your API Token for authenticating terminal requests. | Provided by Moneris. Found in the Moneris Go Portal under Settings / Developer Tools |
| User Id | Mandatory | Your Merchant ID. | Provided by Moneris |
| Client Id | Mandatory | The Application ID for the Moneris Client Credentials (OAuth) application used to communicate with their services. | Created in the Moneris Developer Portal |
| Client Secret | Mandatory | The Secret for the Moneris Client Credentials (OAuth) application. | Created in the Moneris Developer Portal |
| URL 1 | Mandatory | Primary API endpoint for Moneris services. Set automatically by the Initialize action. | Moneris sandbox: https://api.sb.moneris.io Moneris production: https://api.moneris.io |
| URL 2 | Required for card not present transactions | Hosted payment page endpoint for card not present token requests. Set automatically by the Initialize action. | Moneris sandbox: https://esqa.moneris.com/HPPtoken/index.php Moneris production: https://www3.moneris.com/HPPtoken/index.php |
| URL 3 | Required for card present transactions | Terminal API endpoint for card present transaction requests. Set automatically by the Initialize action. | Moneris sandbox: https://ippostest.moneris.com/v3/terminal Moneris production: https://ippos.moneris.com/v3/terminal |
| Payment Method Code | Mandatory | The default payment method code applied to the payment line created by a Moneris transaction. | User-defined |
| Moneris Card Not Present Frame ID | Required for card not present transactions | The hosted payment page Frame ID for card not present (CNP) transactions. | Provided by Moneris. Found in the Moneris Merchant Resource Center |
| Moneris Terminal Store ID | Required for card present transactions | The Store ID assigned to your account for card present (CP) transactions. | Provided by Moneris. Found in the Moneris Go Portal under Settings / Developer Tools |
| Moneris Payment Behavior | Mandatory | Controls how the payment request is sent to Moneris. 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. | Capture |

### Payment Networks: Moneris Identifier Code reference

| **Field** | **Required** | **Description** | **Expected / Default Value** |
| --- | --- | --- | --- |
| Code | Mandatory | A unique code to identify this configuration. | User-defined (e.g., MONERIS) |
| Type | Mandatory | Determines the payment provider used by this configuration. | Moneris |
| API Key | Required for card present transactions | Your API Token for authenticating terminal requests. | Provided by Moneris. Found in the Moneris Go Portal under Settings / Developer Tools |
| User Id | Mandatory | Your Merchant ID. | Provided by Moneris |
| Client Id | Mandatory | The Application ID for the Moneris Client Credentials (OAuth) application used to communicate with their services. | Created in the Moneris Developer Portal |
| Client Secret | Mandatory | The Secret for the Moneris Client Credentials (OAuth) application. | Created in the Moneris Developer Portal |
| URL 1 | Mandatory | Primary API endpoint for Moneris services. Set automatically by the Initialize action. | Moneris sandbox: https://api.sb.moneris.io Moneris production: https://api.moneris.io |
| URL 2 | Required for card not present transactions | Hosted payment page endpoint for card not present token requests. Set automatically by the Initialize action. | Moneris sandbox: https://esqa.moneris.com/HPPtoken/index.php Moneris production: https://www3.moneris.com/HPPtoken/index.php |
| URL 3 | Required for card present transactions | Terminal API endpoint for card present transaction requests. Set automatically by the Initialize action. | Moneris sandbox: https://ippostest.moneris.com/v3/terminal Moneris production: https://ippos.moneris.com/v3/terminal |
| Payment Method Code | Mandatory | The default payment method code applied to the payment line created by a Moneris transaction. | User-defined |
| Moneris Card Not Present Frame ID | Required for card not present transactions | The hosted payment page Frame ID for card not present (CNP) transactions. | Provided by Moneris. Found in the Moneris Merchant Resource Center |
| Moneris Terminal Store ID | Required for card present transactions | The Store ID assigned to your account for card present (CP) transactions. | Provided by Moneris. Found in the Moneris Go Portal under Settings / Developer Tools |
| Moneris Payment Behavior | Mandatory | Controls how the payment request is sent to Moneris. 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. | Capture |
