The following guide covers the prerequisites and steps to set up and use Insight Works’ payment provider integration extension for EBizCharge in Counter Sales.
Prerequisites
Before you begin, ensure you have the following:
- An active EBizCharge account. Contact EBizCharge to obtain one.
- Your API security key (Security ID) provided by EBizCharge.
- Your user credentials (User ID and Password) provided by EBizCharge.
- If using terminals, your terminal key and PIN provided by EBizCharge.
- The EBizCharge 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 EBizCharge
- Navigate to the Counter Sales Payment Provider Configurations page in Business Central (see the Payment Provider Configurations page for more information on setting up and using Payment Provider Configurations).
- Select New and input the following in the General section:
- Code: A unique name to identify this Payment Provider Configuration (e.g., EBIZCHARGE).
- Type: Must be set to EBizCharge; if you do not see EBizCharge in the Type dropdown, the Insight Works app is likely not installed.
- Select Actions / EBizCharge / Initialize (populates the configuration with default settings, including the URLs required to communicate with EBizCharge; a confirmation message appears if initialization is successful).
- Update the Description field as needed (can be done at any time).
- Locate the Connection Details section and enter the credentials provided by EBizCharge (fields masked for security purposes):
- API Key: Your EBizCharge security ID or security key.
- User ID: Your EBizCharge user ID.
- Password: Your EBizCharge password.
- Locate the Payment & Card Details section and modify the following field (required to process Counter Sales payments through EBizCharge):
- Payment Method Code: The payment method code to be applied to the payment line created by each EBizCharge transaction.
- Select Test Connection (a confirmation message indicates whether the connection to EBizCharge was successful by using your API Key, User ID, and Password to request your customer list from EBizCharge).
- Locate the EBizCharge section to configure terminal settings (if applicable; masked for security purposes):
- EBizCharge Terminal Source Key: Provided by EBizCharge.
- EBizCharge Terminal PIN: Provided by EBizCharge.
- Load the terminals associated with your EBizCharge account (if applicable):
- Select Related / Terminals (opens the Counter Sales Payment Provider Terminals page for the current configuration).
- Select Refresh and select OK in the confirmation prompt (refreshes the list with your terminals, including each terminal’s name, status, make, model, and serial number as retrieved from EBizCharge).
- Set the unique EBizCharge identifier code for each network if you are using Payment Networks (optional):
- Select Related / Payment Networks and ensure the Payment Networks list is populated.
- Select Actions / EBizCharge / Set Identifier Code and select which area(s) to update.
- Select OK.
For more information on setting up and using Payment Networks, see the Payment Networks page.
Notes
- For account setup or missing credentials, contact EBizCharge support directly.
- For installation of the Counter Sales Payment Provider integration app, contact Insight Works.
- The EBizCharge 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 / EBizCharge / Clear Current Session Configuration, available on both the list and card pages.
Payment provider configuration: EBizCharge field reference
The following fields are required for EBizCharge 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., EBIZCHARGE) |
| Type | Mandatory | Determines the payment provider used by this configuration. | EBizCharge |
| API Key | Mandatory | Your security ID or security key. | Provided by EBizCharge |
| User Id | Mandatory | Your user ID. | Provided by EBizCharge |
| Password | Mandatory | Your password. | Provided by EBizCharge |
| URL 1 | Mandatory | Service model URL used to communicate with EBizCharge. Set automatically by the Initialize action. |
http://eBizCharge.ServiceModel.SOAP/IeBizService |
| URL 2 | Mandatory | Primary SOAP endpoint for EBizCharge. Set automatically by the Initialize action. |
https://soap.ebizcharge.net/eBizService.svc |
| URL 3 | Required for card present transactions | Payment engine endpoint used for terminal payment requests. Set automatically by the Initialize action. |
https://secure.ebizCharge.com/api/v2/paymentengine/payrequests |
| URL 4 | Required for card present transactions | Payment engine endpoint used for terminal device communication. Set automatically by the Initialize action. |
https://secure.ebizCharge.com/api/v2/paymentengine/devices |
| Payment Method Code | Mandatory | The default payment method code applied to the payment line created by an EBizCharge transaction. | User-defined |
| EBizCharge Terminal Source Key | Required for card present transactions | Your terminal source key. | Provided by EBizCharge |
| EBizCharge Terminal PIN | Required for card present transactions | Your terminal PIN. | Provided by EBizCharge |
| EBizCharge Transaction History Time Period | Required for transaction history | Controls the date range used when retrieving transactions on the EBizCharge Transaction History page. Set automatically by the Initialize action. |
30D |
| EBizCharge Transaction History Maximum Results | Required for transaction history | Limits the number of transactions retrieved on the EBizCharge Transaction History page. Set automatically by the Initialize action. |
1000 |
Payment Networks: EBizCharge Identifier Code reference
The following Identifier Codes are assigned by EBizCharge to each supported payment network. These codes are used to identify the card brand associated with a transaction.
| Payment Network | Moneris Identifier Code |
| Visa | V |
| Mastercard | M |
| American Express | AX |
| Discover | NO |
| Diners Club | NO |
| JCB | J |
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.