OpenCart Plugin Integration
Overview
OpenCart is a free open-source eCommerce platform for seasoned web developers looking for a user-friendly interface and for shop owners just launching their online business.
Prerequisites
Before installing the Verifone Hosted cart, you must meet the following requirements:
- Prerequisites related to the OpenCart tools:
- Install the OpenCart plugin, not older than v3+ (you can download the latest plugin version from https://www.opencart.com)
- Prerequisites related to using Verifone Hosted cart in conjunction with the OpenCart plugin:
- The user that will be utilized in the plugin configuration needs at least one of the following roles assigned: Merchant Supervisor/ Merchant Cashier (in order to check the roles assigned to your user, log in to Verifone Central using the URL you received in your welcome emails and go to Administration → Users)
- You will need to generate a Secure Card Capture key on the organization your user is associated to, in Verifone Central.
OpenCart Integration Settings
Follow the steps below to integrate with the Hosted Payments Page (HPP) by using the OpenCart plugin:
1. Download the Verifone payment module from the link provided in the table at the bottom of this page.
2. Log in to your OpenCart admin panel and navigate to Extensions → Installer.
3. On the Extension Installer page, click on Upload to upload your extension files.
4. Go to Extensions → Choose the extension type and select the Payments extension type from the drop-down list.
5. Scroll down through the Extensions list and click Install on the Verifone Hosted payment option.
Card payment settings
Follow these steps to configure your card payment settings.
1. Click on the Edit button to enable the Verifone Hosted payment option.
2. Use the same Edit button to configure your integration by adding all the required information (you can find all the details in your Verifone Central account).
- General settings
- Production credentials
- Verifone API Username and Password - This is the username and password used to log in to your Verifone Central account.
- API User & API Key - You can find them under Profile → API Keys. Read here how to get your API Key.
- Entity ID - The Entity ID can be found in Verifone Central, under Administration → Organisations. The 'Organisation ID' listed is the Entity ID required for configuring the plugin.
- Payment Contract ID - The payment contract can be found in Verifone Central, under Administration → Payment Contract Providers. The 'Payment Provider Contract ID' listed is the Payment Contract ID required for the plugin configuration.
- 3DS Contract ID - The 3DS Contract ID can be found in Verifone Central, under Administration → 3-D Secure Provider Contracts. Select the 3DS facility required. The ‘3-D Secure Contract ID’ listed is the 3DS Contract ID needed for the plugin configuration.
- Test credentials (If you choose to enable the Test mode. For more details about the Test mode and how you can use it, you can contact our support team.)
- Payment options (select if you want to Use 3DS and CVV on payment)
- Advanced options (choose to enable/disable cURL verify host and peer and overlay when placing order)
3. Click the Save button to save your configuration.
Error handling and Troubleshooting
If you encounter any errors during the installation and configuration of the OpenCart plugin, you can find a log of all errors under the System → Maintenance → Error Logs section.
If some errors are not logged, you can always view the Apache or Nginx logs.
Common errors
- Not having the currency of OpenCart set to the one that the payment contract supports
- Not having created a public key for Secure Card Capture (see section Secure Card Capture Key above)
- Entity ID, Payment Contract ID, or 3DS Contract ID do not match the correct entity for which they were created
- The cURL verify host and peer option is enabled/disabled but the host server does not have proper TLS certificates
- Not having the latest OpenCart module version installed
- Make sure that the credentials are correct: Payment Contract ID, User ID, Password, Realm, Entity ID, Client ID, etc.
In most cases, the error may be caused by various PHP errors and/or warnings.
If the error is caused by a request to the Verifone server, then the error message received when the request fails is very informative. Here is an example:
{
"code": 116,
"details": {},
"timestamp": 1608705038970,
"message": "Access is restricted to authenticated users only. The query can't be made without a valid JWT (check the Authorization header of your request)."
}
The above request was denied because the user was not authorized. This is due to an invalid token being present in the Authorization bearer.
This kind of error format will be present on almost all requests that fail and will deliver a concrete error message along with it which in turn will pinpoint the problem precisely.
Download Verifone Payment Module
Release date | Build | Release notes |
---|---|---|
2022-08-01 | verifone-2.1.1.ocmod__0.zip |
|