On This Page

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.

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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

Setting Up Cron Scheduler for Linux

  1. Open a Linux terminal.
  2. Enter
    crontab-e
     to enter editor mode. For example: 
    root@OpencartQA4:/etc#  crontab -e
  3. Enter the command to set the timing for the cron job. For example, this command sets the cron job to run every 15th minute of every hour, every day, every week, and every month: 
    15 * * * * curl https://www.dev.opencart.cybsplugin.com/mps1760/module/mybank/paymentReport
  4. Enter
    Ctrl + X
     to close the editor.
  5. Enter the
    crontab -l
     command to check the scheduled cron job. For example: 
    root@OpencartQA4:/etc#  crontab -l
    The scheduled cron job should appear on the screen. For example: 
    15 * * * * curl https://www.dev.opencart.cybsplugin.com/mps1760/module/mybank/paymentReport

Setting Up Cron Scheduler for Mac

  1. Open a Mac terminal.
  2. Enter
    crontab-e
     to enter editor mode.
    C02X63PRJG5J:~    $crontab -e
  3. Enter the command to set the timing for the cron job. For example, this command sets the cron job to run every 45th minute of every hour, every day, every week, and every month:
    45 * * * * curl https://www.qa.opencart.cybsplugin.com/mps1786/module/cybersourceofficial/paymentReport
  4. Enter
    Esc + : + w + q
     to close the editor. The editor closes and displays this message:
    crontab: installing new crontab
  5. Enter the
    crontab -l
     command to check the scheduled cron job.
    C02X63PRJG5J:~    $crontab -l
    The scheduled cron job should display on the screen. For example: 
    45 * * * * curl https://www.qa.opencart.cybsplugin.com/mps1786/module/cybersourceofficial/paymentReport

Setting Up Task Scheduler for Windows

  1. Open the Task Scheduler app and click
    Create Task
    .
    The Create Task pane displays.
  2. Select the
    General
     tab and enter a name for the task in the
    Name
     field.
  3. Select the
    Triggers
     tab and click
    New
    .
    The New Trigger pane displays.
  4. Make the desired timing selections for the task in the New Trigger pane and click
    OK
    .
  5. Select the
    Actions
     tab in the Create Task pane and click
    New
    .
    The New Action pane displays.
  6. Select and enter this information in the New Action pane and click
    OK
    .
    • Action drop-down menu:
       choose Start a program.
    • Program/script field:
      enter the
      curl
       command.
    • Add arguments (optional):
       enter the reporting URL.
  7. Click
    OK
     in the Create Task pane to create the task. The new task displays in the Task Scheduler Summary.

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.

Order Management

This section describes the order management process that occurs after a customer places an order.
The order management process is handled using these OpenCart office interfaces:

Order Status

Order status is triggered and updated when transactions are processed. The plugin supports custom and default status states for orders.
Custom order status states:
  • Cancel error
  • Canceled
  • Canceled Reversal
  • Chargeback
  • Complete
  • Denied
  • Expired
  • Failed
  • Order cancelled by merchant
  • Partial Refunded
  • Partial Voided
  • Payment error
  • Payment pending for review
  • Pending
  • Processed
  • Processing
  • Refund Error
  • Refunded
  • Reversal
  • Shipped
  • Void Error
  • Voided
Default order status states:
  • Processed
  • Canceled
  • Shipped
  • Delivered
  • Refunded
Only the shipped and delivered status states can be manually updated.

Order Management Workflows

This section describes the order of events that the merchant completes after a customer submits an order.

After-Authorization Workflow

This workflow comprises the sequence of events that occur after a customer places a new order using OpenCart Front Office. The workflow shows how the order status is updated when the authorized transaction is captured or reversed (full authorization reversal).
  1. The new order displays in OpenCart Back Office and the order status is
    Pending
    .
  2. The merchant chooses one of these actions:
    • Standard capture
      .
    • Partial capture
      .
    • Cancel products
      . For a full authorization reversal, the merchant must also cancel the order, which requires that they select all the quantities and all the items included in the order.
      A partial authorization reversal is not supported.
  3. When the merchant initiates a full authorization reversal, the authorization is cancelled and the order status is set to
    Order cancelled by merchant
    .
  4. When the merchant initiates a multiple partial capture, they choose how many quantities to capture and whether to include the shipping costs.
    After multiple partial captures are processed, the order status is set to
    Processing
    .
  5. When the merchant initiates a full capture, the entire authorization amount is captured and the order status is set to
    Processed
    .

After-Capture Workflow

This workflow comprises the sequence of events that occur after an authorization is captured. The workflow shows how the order status is updated when the captured transaction is refunded or voided.
  1. The merchant selects one of these actions:
    • Standard refund
      .
    • Partial refund
      .
    • Void capture
      .
  2. If the merchant voids the capture, the captured transactions are voided.
    When all quantities of the transaction are captured, the entire order is voided and the order status is set to
    Payment cancelled
    .
    If only a few quantities are captured, only the captured quantities are voided and the order status is set to
    Partial payment accepted
    .
  3. If the merchant initiates a standard refund
    before
     updating the order status to
    shipped
    , the order status is set to
    Partial refunded (before shipped)
     until the refunded amount becomes equal to the captured amount. When the refunded amount becomes equal to the captured amount, the order status is set to
    Refunded
    .
  4. When the merchant selects a refund
    after
     updating the order status to
    shipped
    , the order status is set to
    Partial refunded (after shipped)
     until the refunded amount becomes equal to the captured amount. When the refunded amount becomes equal to the captured amount, the order status is set to
    Refunded
    .
    To refund the amount of an order, merchants can either generate a voucher or a credit slip for the refund. Depending on the type of refund they select and whether they issue a voucher or a credit slip, one of these actions occurs:
    • When the merchant chooses
      Generate a voucher
       for a partial refund, the sum of the items is not refunded. Instead, a voucher is generated that can be used for future transactions.
    • When the merchant chooses
      Generate a voucher
       and enters the amount in the shipping costs field for a partial refund, then a voucher equal to the sum of the items and the shipping amount is generated.
    • When the merchant chooses
      Generate a credit slip
       for a standard refund, the sum of the items is refunded.
    • When the merchant chooses both
      Generate a credit slip
       and
      Repay shipping costs
       for a standard refund, the sum of the items and the shipping amount are both refunded.
    • When the merchant chooses both
      Generate a voucher
       and
      Repay shipping costs
       for a standard refund, a voucher equal to the sum of the items and shipping amount is generated.
    • When the merchant chooses both
      Generate a voucher
       and
      Generate credit slip
       for a standard refund, a voucher is generated and a refund for the sum of the items is not generated.

After-Refund Workflow

This workflow comprises the sequence of events that occur when the merchant voids a refund under specific conditions:
  • When the refund is processed
    before
     the order is shipped, the refund is cancelled and the order status is set to
    Voided
     or
    Partially Voided
    .
  • When the refund is processed
    after
     the order is shipped, the refund is cancelled and the order status is set to
    Voided
     or
    Partially Voided
    .
  • When the voided refund amount is equal to the refund amount, the refund is cancelled and the order status is set to
    Voided
     or
    Partially Voided
    .
OpenCart does not provide an option to return Gift Certificates. For orders associated with Gift Certificates, the services mentioned below are not available:
  • Front Office Cancel
  • Back Office Cancel
  • Void a Capture

Customer Tasks

Customers can use the My Account option on the merchant's OpenCart website to manage orders and their payment information. The following sections contain the steps to complete these tasks.

Saving Credit/Debit Card Information

Saving card information enables customers to use that information for future transactions. Using OpenCart Front Office, customers can save their card information during the checkout process, or they can add their card's information to their registered OpenCart accounts using the Cybersource My Cards feature.
If a customer wants to save their card information during the checkout process, they can select the
Save my card for future payment
option when entering their credit/debit card payment during checkout.
The card information can also be saved using the Cybersource My Cards page in OpenCart:
  1. Open OpenCart Front Office.
  2. Click
    My Account > Managed Stored Credit Cards > Cybersource My Cards > Add New Card
    .
    If there is no current address associated with the customer account, the customer is prompted to add an address. The customer can enter the required address information and click
    Save
    .
    If there is already an address associated with the customer account, the customer can select and use the address or add a new address.
    After the address information is complete and selected, the customer can update the card expiration information, if needed, or delete the existing card from the account.
  3. To update the expiration information (expiration month/year) for the card, under
    Saved Cards
     the customer clicks the blue arrow beneath
    More
    , then clicks either
    Update
    , or
    Delete
     to remove the card from the account.
    Customers can only add the number of cards that the merchant specified in the account configuration. The updated card information is tokenized and securely saved. The customer can use the saved card information for future transactions without having to enter that card information during the checkout process.

Selecting a Default Credit/Debit Card

When a customer has multiple cards associated with their account, they can designate the default card. By default, the first card added to the account will be set as the default card. In the Cybersource My Cards page, the default card is identified using an asterisk (*) that appears to the right of the card number.
To change the default card, the customer follows these steps:
  1. Open OpenCart Front Office.
  2. Open the Cybersource My Cards page. The page displays the saved cards associated with the account.
  3. Choose the card to set as the default card and select
    More > SET AS DEFAULT
    . The card is set as the default card.
    The default card cannot be deleted unless all other saved cards from the Cybersource My Cards section are deleted.

Cancelling an Order

This task provides the steps a customer takes to cancel an order. They cannot cancel an order if the order is in review with the merchant. The Cancel option is also not available in direct Settlement for Captured and
eCheck
 orders.
  1. Open OpenCart Front Office.
  2. Select
    My Account > Order History
    . The Order history page displays the customer's orders.
  3. Select the View icon for the order. The Order details page appears.
  4. Click the
    Cancel Order
     icon to cancel the order.
    A Cancel Order confirmation notice appears.
  5. Click
    Yes
     on the Cancel Order confirmation notice to cancel the order.
    Above the Order History, a notification appears stating
    Success: Entire order was successfully cancelled.
     The order is cancelled and the order status is set to
    Canceled
    .
    If the order was a sales transaction or was captured, the cancellation is sent to the merchant and the status is set to
    Canceled
    .
    After the customer cancels an order, the merchant can accept or reject the order cancellation (as instructed in Processing a Cancelled Order).
    If the merchant accepts the cancellation request, a refund for the order amount is initiated and the order status is set to
    Refunded
    . If the merchant rejects the cancellation request, the order status is set to
    Denied
    .

Merchant Tasks

Merchants use OpenCart Back Office to manage orders. This section describes the steps to complete these tasks.

Processing a Cancelled Order

When a customer cancels an order, a request is sent to the merchant and the order status is set to
Cancelled
. Merchants can accept or reject an order that a customer cancels.
  1. Open OpenCart Back Office and select
    Orders
     from the Dashboard.
  2. Locate and select the checkbox next to the order the customer cancelled.
  3. Click the View icon. Under Order Details, the information for that order displays.
  4. Under
    Add Order Status
    , choose the order status that describes your processing of the cancellation.

Processing a Merchandise Return

When a customer requests to return merchandise, the information appears on the Merchandise Returns page in OpenCart Back Office. Follow these steps to process the return.
  1. Open OpenCart Back Office and select
    Sales > Returns
    . The Product Returns page displays and identifies the order or orders for which customers have requested a return.
  2. Select the check box next to the order for which you want to process the return. Then click the Edit icon. The Edit Product Return page displays.
  3. In the Product Information and Reason for Return pane, choose one of these options from the Return Action drop-down menu:
    • Credit issued
    • Refunded
    • Replacement Sent
    The status is updated for the order on the Merchandise Returns page. Next, you can proceed with selecting a return or refund option for the order.
  4. Select
    Orders
     from the Dashboard.
  5. Select the order for which you want to process a return, and select one of these options:
    • Return products
    • Partial refund

Fraud Management

The plugin provides fraud management functionality for merchants who also use the
Business Center
. You can apply fraud management functionality to transactions when:
  • Fraud management is enabled in the plugin.
  • You have a fraud management profile in the
    Business Center
    .
Fraud screening includes these features:
  • Fraud Management Essentials (FME):
     used to enforce the rules created by Cybsource Machine Learning System (MLS). Fraud management is used to define the merchant’s rules.
  • Fraud Management Rules:
    • When the decision status from the
      Business Center
       is AUTHORIZED_PENDING_REVIEW or PENDING_REVIEW, the order is in review and the order status is set to
      Payment pending for review
      .
    • When the decision status from the
      Business Center
       is AUTHORIZED_RISK_DECLINED, the order is rejected and the order status is set to
      Order cancelled by merchant
      .
The table below describes the possible decisions, outcomes, and timing Decision Manager uses when an order is triggered for review.
When these transactions are in a Decision Manager review state, certain settlement considerations apply:
  • For authorizations:
     while accepting this transaction it is not recommended to settle it in the
    Business Center
    . When the transaction is settled in the
    Business Center
    , the follow-on services initiated from OpenCart Back Office are impacted.
  • For sales:
    • The entire authorized amount should be settled in the
      Business Center
       when accepting the transaction. When the settlement is not performed in the
      Business Center
      , the follow-on services initiated from OpenCart Back Office fail.
    • A follow-on void capture will not trigger from OpenCart Back Office. While accepting review transactions, merchants should not select the settle option.
Decision Manager Decisions, Execution Timings, and Outcomes for Orders
Decision
Execution Timing
Outcome of Decision
Monitor
Before authorization
Authorization will be successful and no action from the Decision Manager is required. Use this decision to understand the outcome of a rule.
Accept
Before authorization
The order is processed normally and is placed successfully.
Review
Before authorization
The authorization is successful, and follow-on services are put on hold until the merchant accepts or rejects it. The order status will be set to
Payment pending for review
.
Reject
Before authorization
The order is rejected and the authorization is not processed. The merchant is not able to view the order in OpenCart Back Office.
Monitor
After authorization
The authorization is successful and no action from Decision Manager is required. Use this decision to understand the outcome of a rule.
Accept
After authorization
The order is processed normally and placed successfully.
Review
After authorization
The authorization is successful, and follow-on services are put on hold until the merchant accepts or rejects it. The order status is set to
Payment pending for review
.
Reject
After authorization
The original authorization is successful and then is automatically reversed and the order status is set to
Order cancelled by merchant
.

Reporting

The plugin provides reporting functionality for merchants who also use the Cybersource
Business Center
. You can import these reports from the
Business Center
 into OpenCart:
  • Transaction Request Report:
     includes details for individual transactions that are processed each day.
  • Payment Batch Detail Report:
     includes transactions that are processed with the applications. This report is available shortly after captured transactions are batched.
  • Conversion Detail Report:
     includes Case Management changes recorded in the
    Business Center
     to ensure that updated orders are also included in OpenCart. This report is generated at regular intervals and includes the results of the converted orders for each reviewer. This information provides an overview of all orders that were not immediately accepted.

Scheduling

The Plugin reporting functionality works with a system scheduler to generate and update reports for OpenCart. There are some Cron Job modules available for OpenCart, such as the Cron Tab, that support reporting. Merchants can use any Cron Job module that OpenCart supports, or any other online Cron service provider to generate reports.
See Scheduling Report Generation for information about how to schedule report generation.

Workflow

The reports are processed and orders are updated in OpenCart using this workflow:
  1. Orders with an
    AUTHORIZED_PENDING_REVIEW
     or
    AUTHORIZED_RISK_DECLINED
     status are included in the
    ps_cybersourceofficial_order
     table in the OpenCart database.
  2. If a review is trigged for an order based on the profile rule in Decision Manager, a
    Payment pending for review
     order status displays for that order on the OpenCart Back Office Orders page.
  3. The merchant uses the
    Business Center
     to accept the order that is in review, and, if not already enabled, enables the reports using the Report Settings on the Plugin Configuration page.
  4. The scheduler runs the report at regular intervals according to the intervals the merchant configured. The order is accepted or rejected by the merchant in the
    Business Center
    , is retrieved, and the new status is updated as
    AUTHORIZED
     or
    DECLINED
    . The updated order status displays in the
    op_cybersourceofficial_order
     table in the OpenCart database.
  5. The original decision and the new decision are updated and displayed in the
    op_cybersourceofficial_conversion_detail_report
     table in the OpenCart database.
  6. The order is updated as
    Awaiting payment
     status for the authorization and displayed on the OpenCart Back Office Orders page. The payment is accepted for the sale and any associated follow-on transactions (capture, void capture, refund, void refund, and full authorization reversal).

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

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.

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