Using ECommPay payment module for OpenCart 3.0 CMS

This manual describes how to use the ECommPay payment module plug-in version 3.0. The plug-in allows you to use ECommPay payment solutions for sites that are based on CMS OpenCart version 3.0 or later.

To download the plug-in ECommPay payment module follow the link here.

Operational scheme

Interaction with ECommPay payment solutions is performed by using a payment page.



Figure: The diagram of payment processing with plug-in enabled

Request for opening the payment page is automatically generated by the plug-in when ECommPay is selected as a payment method.

If the payment is declined, a customer may re-enter the data on the payment page.

Upon receipt of the payment result, a callback is sent to the site's system. The callback is processed by the plugin automatically. In accordance with the payment result, the status of the order changes to:

  • Failed status — payment is declined.
  • Success status — payment is successful.

Installing

To install a plug-in, do the following:

  1. Open OpenCart.
  2. Go to the section Extensions > Extension Installer.
  3. Click the Upload button and select the file with the plug-in in the format: ocmod.zip or ocmod.xml.
  4. Click the Continue button.


  5. Go to the section Extensions > Modifications and make sure that ECommPay payment module payment module has appeared in the modification list.
  6. Click the button to rebuild modification cache.


Testing

When the plug-in is activated, the test mode is used by default. By using this mode, you can get familiar with the operation process of the plug-in connected to the site, without an option to perform payments in real time. In the test mode, you may configure and test the plug-in, perform test orders and view information about the them.

Configuration

To configure parameters of the plug-in in the test mode, do the following:

  1. Go to the section Extensions > Extensions and select the extension type — Payments.
  2. Find payment type ECommPay in the table Payments and click the button in the corresponding row.
  3. Click the button in the same row in order to configure parameters of the plug-in.
  4. Configure the required settings. For more details see below.
  5. Make sure that the Test mode checkbox is checked.
  6. Click the button to save changes.

The plug-in has the following settings:

  • Field Status — to display the payment method by using ECommPay payment page on the site.
  • Parameters of ECommPay payment page operation while displaying:
    • Title — a name of the payment method on the site.
    • Description — information about the payment method on the site.
    • Additional parameters — additional parameters of the payment page.

      A list of these parameters is available Payment Page invocation parameters. When specifying two or more parameters, they must be entered with "&" as separator.

    • Language — a language of the payment page.
    • Currency — a currency of the payment page. A number of decimal places is required. Otherwise, the payment amount is displayed incorrectly.
    • Popup mode — the way of displaying the payment page in the popup or in the current tab.
    • Sort Order — an order number of the payment method displayed in the list of available payment methods on the site.
  • Other parameters of the plug-in:
    • Pending status — status during the order confirmation.
    • Success status — status when the order is successful.
    • Failed status — status when the order is declined.
    • Geo Zone — a region where the payment method is available.
  • Parameters Project ID and Secret key are used for implementing ECommPay payment solutions.

    They are not used in the test mode.

Performing test orders

Once the parameters of the plug-in are configured you should perform test orders on the site and check information regarding the orders in OpenCart in the section Sales > Orders.

Note: In the test mode in order to change order's status from Pending Status to Success status once you complete a payment, you should click the Back to Website button. Otherwise, the order's status remains Pending Status.

Launching

Once the plug-in is tested using all the planned payment methods it may be switched to production mode. In order to do this, you should receive the parameters for the production mode and adjust settings.

Receiving the parameters for the production mode

To receive the parameters for connecting to ECommPay payment solutions, do the following:

  1. Contact ECommPay technical support and provide the following parameters:
    • The site name and its URL.
    • The payment page currency.
    • URL to receive callbacks (URL, specified in settings, in the field Callback endpoint).


  2. Receive from ECommPay technical support the following parameters:
    • Project ID — site identifier.
    • Secret key — secret key, that is generated for a particular merchant in the ECommPay processing system.

Configuring the operational parameters

In order to set the operational parameters, do the following:

  1. Open OpenCart.
  2. Go to the section Extensions > Extensions > Payments.
  3. Select ECommPay from the list and click the button.
  4. Configure the operational parameters:
    • Clear the Test mode checkbox.
    • Fill in the fields Project ID and Secret key in accordance with the values received from ECommPay technical support.
    • Make sure, that the remaining parameters are set to the required values.
  5. Click the button to save changes.

Using

Once the plug-in is launched it operates autonomously.

We recommend that you control orders by reviewing the information in the section Sales > Orders, and also to make sure that order numbers are unique within the site. In the case when an order number duplicates, the payment page does not open and the order's status remains Pending status.

If the plug-in is already operating in the production mode and you require to switch it back to the test mode, pay attention to how the payment method is displayed on the site. If the Test mode checkbox is selected and Enabled option is selected in the Status field, the payment method using the ECommPay payment page is displayed on the site. However, all payments are performed as test payments.

Before you switch the plug-in back to the production mode, make sure that the Project ID and Secret key fields are filled in accordance with the values received from ECommPay technical support.

If you have any further questions with regards to the plug-in operation contact ECommPay technical support by email support@ecommpay.com