OpenCart

The plugin for OpenCart provides a payment solution for merchants using OpenCart to manage their orders. This section describes the payment methods and services the Plugin provides.

Supported payment methods

These are the supported payment methods for OpenCart:
  • Credit and debit cards
  • eCheck
  • Click to Pay

Supported payment services

These are the supported payment services available for OpenCart:
  • Payment acceptance services
    • Authorization only
    • Sale (bundled authorization and capture)
    • Electronic check debit (sale) for
      eCheck
       payment method
  • Order management services
    • Capture an authorization (not for
      eCheck
      )
    • Multiple partial captures (not for
      eCheck
      )
    • Standard and partial refunds
    • Standard and partial void captures (not for
      eCheck
      )
    • Standard and partial void refunds
    • Full authorization reversal (not for
      eCheck
      )
  • Token Management Service
     (
    TMS
    ) for credit and debit cards payments
    :
    • Create payment token along with authorization
    • Update an existing token along with authorization
    • Update an existing token from My Account section
    • Delete an existing token from My Account section
    • Create payment token for new payment methods during checkout
    • Make a payment with a stored token during checkout
  • Reporting services that allow you to import theses
    Business Center
     reports into OpenCart
    :
    • Transaction Request Report
    • Payment Batch Detail Report
    • Conversion Detail Report

Release Information

This section provides information about the releases for the plugin.
Release Version
Release Date
Support End Date
Version 22.1.0
October 25, 2022
October 14, 2025
Version 23.1.0
December 8, 2023
December 7, 2026
Version 23.1.0 includes the following enhancements:
  • Updated authentication signature
  • Added DAV enable/disable button for admin configuration
  • Updated reCAPTCHA key generation tooltip URL
  • Fix for target origin issue for different domain in the flex form capture context
  • Compatible with OpenCart versions 3.0.3.7 and 3.0.3.8
Version 22.1.0
  • Initial release.
OpenCart

Installation

Before you install the plugin, make sure that these requirements are met:
Follow these steps to install the plugin:
  1. Download the plugin from the OpenCart website to your local system.
  2. Open OpenCart Back Office and from the Dashboard, choose
    Extensions
     >
    Installer
    .
  3. Click
    Upload
     and browse to the file you downloaded to your local system.
    The pane displays the status of the installation. After the Plugin is installed, the pane indicates that the module is installed. You can close it or click
    Configure
     to configure the Plugin.
OpenCart

Configuration Overview

This section describes how to set up the plugin.
The following table shows where to access the plugin configuration settings.
From the left navigation panel in OpenCart Back Office, select
Extensions
 and follow the path indicated in the table for the configuration settings you want to configure.
Configuration Settings
Settings
Path
  • General Configuration
  • Report Configuration
  • Order Status Configuration
Extensions > Extensions > Modules > Cybersource Configuration
Unified Checkout
  • Payment Action
  • Payer Authentication
  • Status
  • Sort Order
  • Tokenization
  • Limit Saved Card Rate
  • Enforce SCA for Saving Card
Extensions > Extensions > Payments > Cybersource
Unified Checkout
eCheck
  • Status
  • Sort Order
Extensions > Extensions > Payments > Cybersource
eCheck
OpenCart

Enable Basic Configuration

This section describes the required and optional basic configuration settings for the plugin.
To enable Basic Configuration, follow these steps:
  1. In OpenCart Back office, navigate to
    Extensions
     >
    Extensions
     >
    Modules
     >
    Cybersource Configuration
    .
  2. Click the
    Edit
     icon.
  3. In the General Configuration tab of the Edit Cybersource Configuration Module pane, from the drop down list or text box, select or enter a setting.
  4. Click the
    Save
     icon.
  5. Repeat for each required setting and each optional setting you want to enable.

Required Settings

These settings are required for using the plugin:
Sandbox Mode
Set to
Enable
 to operate in Sandbox (T) mode. You can test new changes in this mode and no funds are affected.
Set to
Disable
 to operate in Production (Live) mode.
Merchant ID
Enter the
Business Center
 Merchant ID or Organization ID, which is a unique identifier for the merchant.
Merchant Key ID
Enter your REST Shared Secret Key generated from within the
Business Center
. This specific key authenticates and authorizes the merchant's integration with the gateway.
Merchant Secret Key
Enter the complimentary Secret key that is generated at the same time as the Merchant Key ID. It is used for secure communication between the merchant's online store and a payment gateway.
reCAPTCHA Site key
For each request, this key returns a score based on the user interactions with your site. Based on these scores, you can take appropriate actions for your site, such as allowing or blocking users.
reCAPTCHA Secret key
This key authorizes communication between the plugin's backend and the reCAPTCHA server to verify the user's response. The secret key should be kept safe for security purposes.

Optional Settings

These settings are optional for using the plugin.
Fraud Management
Set to
Enable
 to allow merchants to identify and prevent fraudulent activities.
Delivery Address Verification
Set to
Enable
 to allow merchants to verify the delivery address.
Device Fingerprint
Set to
Enable
 to allow merchants to identify and track devices accessing an online store.
Developer ID
Identifier for the developer that helps integrate a partner solution with Cybersource. This settings is only required for Cybersource System Integrators.
Status
Set to
Enable
 for the Cybersource integration to be active and visible at checkout.
Payment Action
Set to
Enable
 to enable card payments for Authorize Only or Sale (Authorization and Capture) for front office transactions.
Enhanced Logs
Set to
Enable
 to generate logs that can be accessed by selecting
Configure
 >
Advanced Parameters
 >
Logs
.
Cybersource
 strongly recommends you map your Order Status responses to your preferred order status under the Order Status Configuration section.
OpenCart

Enable
Unified Checkout

This section describes the required and optional configuration settings for
Unified Checkout
 for the plugin.
To enable Card Payment follow these steps:
  1. In OpenCart Back office, navigate to
    Extensions > Extensions > Payments > Cybersource
    Unified Checkout
    .
  2. Click the
    Edit
     icon.
  3. In the Edit Cybersource
    Unified Checkout
     pane, from the drop down list or text box, select or enter the setting you want.
  4. Click the
    Save
     icon.
  5. Repeat for each required setting and each optional setting you want to set.

Required Settings

The following settings are required:
The following settings are required for enabling
Unified Checkout
 for the plugin:
Payment Option Label
Enter the text you want displayed to the customer at checkout.
Allow Card Types
Select the card types that you want to accept.

Optional Settings

The following settings are optional for enabling
Unified Checkout
 for the plugin:
Status
Set to
Enable
 for the Cybersource integration to be active and visible at checkout.
Sort Order
Order in which a payment method displays at checkout.
OpenCart

Enable Tokenization

This section describes the required and optional configuration settings for Tokenization for the plugin.
To enable Tokenization follow these steps:
  1. In OpenCart Back office, navigate to
    Extensions > Extensions > Payments > Cybersource

    Unified Checkout
    .
  2. Click the
    Edit
     icon.
  3. In the Edit Cybersource pane, from the drop down list or text box, select or enter the setting you want.
  4. Click the
    Save
     icon.
  5. Repeat for each required setting and each optional setting you want to set.

Required Settings

The following settings are required:The following setting is also required for enabling Tokenization for the plugin:
Tokenization
Setting allows customers to save cards for future use while making a card payment.

Optional Settings

The following settings are optional for enabling Tokenization for the plugin:
Network Token Updates
Enable this setting to subscribe to Network Token life cycle updates.
Limit Saved Card Rate
With this setting enabled, a limit is set to save only a specified number of cards in the My Account section in Front Office. There are two settings:
Saved Card Limit Count
: Number of cards that can be saved in a certain period of time.
Saved Card Limit Time Frame
: Number of hours that saved card attempts are counted.
Enforce SCA for Saving Card
If enabled, card holders are 3DS challenged when saving a card.
OpenCart

Enable Fraud Management

This section describes the required and optional configuration settings for Fraud Management for the plugin.
To enable Fraud Management follow these steps:
  1. In OpenCart Back office, navigate to
    Extensions > Extensions > Modules > Cybersource Configuration
    .
  2. Click the
    Edit
     icon.
  3. In the General Configuration tab of the Edit Cybersource Configuration Module pane, from the drop down list or text box, select or enter the setting you want.
  4. Click the
    Save
     icon.
  5. Repeat for each required setting and each optional setting you want to enable.

Required Settings

The following settings are required:The following settings are also required for enabling Fraud Management for the plugin.
  • Fraud Management
  • Device Fingerprint (not technically required, but highly recommended)

Optional Settings

The following setting is optional for enabling Fraud Management for the plugin:
Conversion Detailed Report
This report (enabled in the Report Configuration tab) pulls Case Management changes from Cybersource at regular intervals to ensure orders are kept updated within OpenCart.
OpenCart

Enable 3-D Secure (Payer Auth)

This section describes the required and optional configuration settings for 3-D Secure (Payer Auth) for the plugin.
To enable 3-D Secure follow these steps:
  1. In OpenCart Back office, navigate to
    Extensions > Extensions > Payments > Cybersource
    Unified Checkout
    .
  2. Click the
    Edit
     icon.
  3. In the Edit Cybersource pane, select from the dropdown or specify in the text box the configuration setting option you want to set.
  4. Click the
    Save
     icon.
  5. Repeat for each required setting and each optional setting you want to enable.

Required Settings

The following settings are required:The following setting is also required for enabling 3-D Secure for the plugin:
Payer Authentication
When this setting is enabled, an extra layer of security is added at checkout.

Optional Settings

The following setting is optional but recommended for regions enforcing 3-D Secure for the plugin:
Enforce SCA for Saving Card
When this setting is enabled, card holders are 3-D Secure challenged when saving a card.
OpenCart

Enable
eCheck

This section describes the required and optional configuration settings for
eCheck
 for the plugin.
To enable
eCheck
 follow these steps:
  1. In OpenCart Back office, navigate to
    Extensions > Extensions > Payments > Cybersource
    eCheck
    .
  2. Click the
    Edit
     icon.
  3. In the Edit
    eCheck
     pane, from the drop down list or text box, select or enter the setting you want.
  4. Click the
    Save
     icon.
  5. Repeat for each required setting and each optional setting you want to enable.

Required Settings

The following settings are required:The following setting is also required for enabling
eCheck
 for the plugin:
Status
With this setting enabled,
eCheck
 is active.

Optional Settings

The following setting is optional but recommended for enabling
eCheck
 for the plugin:
Sort Order
Order in which a payment method displays at checkout.
OpenCart

Enable Reporting

This section describes the required and optional configuration settings for Reporting for the plugin.
To enable Reporting follow these steps:
  1. In OpenCart Back office, navigate to
    Extensions > Extensions > Modules > Cybersource Configuration
    .
  2. Click the
    Edit
     icon.
  3. In the Report Configuration tab of the Edit Cybersource Configuration Module pane, from the drop down list or text box, select or enter the configuration setting you want.
  4. Click the
    Save
     icon.
  5. Repeat for each required setting and each optional setting you want to enable.

Required Settings

The following settings are required: The following settings are also required for enabling Reporting for the plugin:
Payment Batch Detail Report
This report includes transactions that are processed with the applications. This report is available shortly after captured transactions are batched.
When set to
Enable
, this report is downloaded from the
Business Center
 to OpenCart. The report is downloaded by default to different locations, depending on the mode in which OpenCart is operating:
  • In Sandbox (Test) mode, the report downloads to
    {OpenCartModuleInstallationDirectory}/cybersourceofficial/Reports/Sandbox
  • In Production (Live) mode, the report downloads to
    {OpenCartModuleInstallationDirectory}/cybersourceofficial/Reports/Production
    .
Cybersource strongly recommends that OpenCart and the
Business Center
 operate in the same time zone so that the Transaction Request Report and Payment Batch Detail Report work properly.
Transaction Request Report
This report includes details for individual transactions that are processed each day.
When set to
Enable
, this report is downloaded from the
Business Center
 to OpenCart. The report is downloaded to different locations, depending on the mode in which OpenCart is operating:
  • In Sandbox (Test) mode, the report downloads to
    {OpenCartShopModuleInstallationDirectory}/cybersourceofficial/Reports/Sandbox
  • In Production (Live) mode, the report downloads to
    {OpenCartModuleInstallationDirectory}/cybersourceofficial/Reports/Production
    .
Cybersource strongly recommends that OpenCart and the
Business Center
 operate in the same time zone so that the Transaction Request Report and Payment Batch Detail Report work properly.

Optional Settings

The following settings are optional but recommended for enabling Reporting for the plugin:
Download path
If you want to download the report to a path other than the default, specify that path here.
Conversion Detail Report
When set to
Enable
, this report pulls Case Management changes from the
Business Center
 at regular intervals to ensure orders are updated in OpenCart.
OpenCart

Enforcing Strong Customer Authentication

Select the Enforce Strong Customer Authentication setting to prompt a 3-D Secure (3DS) challenge when a customer saves their credit card information. The customer is 3DS challenged when a transaction is declined as reported by response code 478 (Strong Customer Authentication required). After the transaction is declined, another request is sent for the same order.
The Enforce Strong Customer Authentication setting is only available when the Payer Authentication/3-D Secure (General Plugin setting) and Tokenization (Fraud Management Plugin setting) are enabled. See Enable 3-D Secure (Payer Auth) and Enable Tokenization for information about enabling these settings.
Follow these steps to enable Enforce Strong Customer Authentication:
  1. Open OpenCart Back Office and select
    Extensions
     >
    Extensions
     >
    Payments
     >
    Cybersource
    Unified Checkout
    .
  2. Select the
    Edit
     icon.
  3. From the drop down menu next to Enforce SCA for Saving Card, select
    Enable
    .
  4. Click the
    Save
     icon.
OpenCart

Scheduling Report Generation

Schedulers on a Linux, Mac, or Windows system are used to set up how often a specified report is generated. Schedulers for Linux and Mac systems are set up using a Cron Tab. The scheduler for a Windows system is set up using the Windows Task Scheduler app.
When setting up a schedule for generating a specific report, use this format:
  • Format:
     <
    shop domain name
    >/module/cybersourceofficial/paymentReport
  • Example:
    http://www.opencart_1.7.8.6.com/module/cybersourceofficial/paymentReport

Cron Tab Syntax for Mac and Linux Systems

When setting up the reporting schedule on a Linux or Mac system, you use
crontab
 commands that determine how often and when the report is generated.
The syntax is: 
* * * * * [command]
The asterisk (*) represents each of these timing parameters:
  • Minute (0-59)
  • Hour (0-23)
  • Day of Month (1-31)
  • Month (1-12)
  • Day of week (0-6), (0-Sunday)
For example, these timing parameters indicate how often a specified report is generated:
  • * * * * * [command]
    : Runs every minute of every day of every week of every month.
  • 0 * * * * [command]
    : Runs every hour of every day of every week of every month.
  • 30 2 * * * [command]
    : Runs at 2:30 a.m. every day of every week of every month.
  • 0 0 2 * * [command]
    : Runs once a month every month on the second day of the month.
  • 0 * * * 1 [command]
    : Runs every Monday at every hour.
  • 0,10,20 * * * * [command]
    : Runs on 0, 10, 20 minute of every hour of every day of every week of every month.
  • 0 5-10 * * * *[command]
    : Runs every hour between 5 and 10 a.m.
  • @reboot [command]
    : Runs every time after the server reboots.
  • */5 * * * * [command]
    : Runs every 5 minutes of every day.
OpenCart

Using the Plugin

The plugin provides merchants a frictionless way to process payments, prevent fraud, and generate reports within the
Business Center
 while making it easy for customers to place and cancel orders, and save or update stored credit or debit card information.
OpenCart

Testing

If you have not done so already, configure these settings using OpenCart Back Office:
  • General Settings:
     merchant ID, merchant key ID, and/or merchant secret key
  • Payment Settings:
     applicable payment methods
After configuring the Plugin, complete this task to test the configuration using OpenCart Front Office to place an order and OpenCart Back Office to manage the order.
  1. Open OpenCart Front Office to place an order.
  2. At Checkout, enter any required personal information and select the payment method you want to use to place the order.
  3. Enter the card information you want to use to place the order and click
    Confirm Order
    . If the order is successful, an order confirmation message displays.
  4. Open OpenCart Back Office to manage the order.
  5. Select
    Orders
    from the Dashboard. The Orders page displays and lists all active orders.
  6. Select the checkbox next to the order you processed in Step 1. Then click the View icon. The order status for the order should display
    Pending
    .
  7. Click
    Capture
     to capture the authorized amount, then
    Yes
    . The order status changes to
    Processed
    .
  8. Click
    Partial capture
     to capture part of the authorized amount. The order status changes to
    Processing
    .
  9. Click
    Cancel
     to cancel the order. The order status changes to
    Order Cancelled by Merchant
    .
    For more information about testing, including test cards, see testing-guide-v1.html
OpenCart

Upgrading

You can install a newer version of the plugin using OpenCart Back Office.
  1. To uninstall Cybersource Payment, navigate to
    Extensions > Extension Types > Payments
     and then uninstall all of the Cybersource payment modules.
  2. To uninstall Cybersource Tax, under the same Extension dropdown, select
    Order Totals
     and uninstall Cybersource Tax.
  3. To uninstall the Cybersource Payment extension, under the Extension dropdown, select
    Modules
    , and uninstall the Cybersource Payment extension.
  4. Navigate to the Extensions tab and click
    Installer
    , then click
    Delete
     to remove the Cybersource extension.
  5. Navigate back to the Extensions tab and click
    Modification
    , then click
    Refresh
    .
  6. To install the new Cybersource Payment extension, follow the steps mentioned in Installation.
OpenCart

Troubleshooting Assistance

For help with troubleshooting, contact GlobalPartnerSolutionsCS@visa.com and provide the following information:
  • Summary of the issue
  • Steps needed to reproduce the issue
  • Platform version
  • Plugin version
  • Platform Merchant ID
  • Configuration screenshots
  • List of themes/additional extensions installed
  • Log file and any other data or screenshots related to the issue
OpenCart