OpenCart

Source Files

You can download the latest extension version here.


Requirements

  • OpenCart 4.1.x
  • Valid SSL certificate
  • PHP 8.1 or later with the cURL extension enabled
  • Ecom merchant account with E_API credentials
  • KWD configured as an available OpenCart currency

Installation Steps

  1. Configure OpenCart and add KWD as an available currency before installing
    Ecom Payments.
  2. Log in to the OpenCart admin panel.
  3. Go to Extensions → Installer.
  4. Click the upload button and upload the downloaded ecom.ocmod.zip file.
  5. Wait until OpenCart confirms that the extension was installed.
  6. Go to Extensions → Extensions.
  7. Select Payments from the extension type list.
  8. Find Ecom and click the Install button.
  9. Click the Edit button to configure the extension.

Merchant Configurations

In the OpenCart admin panel, configure the extension under
Extensions → Extensions → Payments → Ecom → Edit.

Add your Ecom credentials from the Ecom portal. You can get them from
Account → API Credentials.

ConfigurationDescription
API TokenYour API token from the Ecom portal.
Merchant IDYour merchant MID from the Ecom portal.
EnvironmentSelect Sandbox for testing or Production for live payments. Environment and credentials must match.
Webhook SecretYour webhook secret from the Ecom portal API Credentials tab.
Geo ZoneSelect All Zones or limit Ecom Payments to a specific customer location.
StatusSelect Enabled to display Ecom Payments during checkout.
Sort OrderControls the position of Ecom Payments among the available checkout methods.

Click Save after entering the configuration.

The extension displays a webhook URL below the Webhook Secret field. Copy this
URL and add it as the transaction webhook endpoint in the Ecom portal. The URL
must be public, use HTTPS, and must not be blocked by authentication, maintenance
mode, a firewall, or a proxy.

All charges use the Ecom-hosted payment page in INDIRECT mode. The extension
is available only for KWD orders and does not support subscription carts.

Order statuses are updated automatically:

  • INITIATED or PENDING uses the OpenCart pending status.
  • CAPTURED uses the OpenCart complete status.
  • Other terminal payment statuses use the OpenCart failed status.

Before switching to Production, complete a Sandbox payment and confirm that the
customer returns to the OpenCart success page and the order changes to the
complete status.

If an integration error occurs, open System → Maintenance → Error Logs.
Search for Ecom gateway error or Ecom callback verification failed. Gateway
error logs include the request body and Ecom response but never include the API
token.