Using ecommpay for osCommerce CMS

This manual describes how to work with plug-in ecommpay version 1.0. The plug-in allows to use ecommpay payment solutions for sites that are based on CMS osCommerce version 2.3 or later. The required PHP version for CMS osCommerce is 5.6 or later.

To download the plug-in ecommpay 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 plug-in automatically. In accordance with the payment result, the status of the order changes to:

  • Pending — payment is declined.
  • Processing — payment is successful.

Installing

To install a plug-in, upload the plug-in files to the root folder of the project: public_html.

Once the plug-in is uploaded it is displayed in the list of plug-ins in the section Modules > Payment.



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 Modules > Payment.
  2. Select ecommpay in the list and click the Edit button.


  3. Configure the required settings. For more details see below.
  4. Make sure, that True is selected in the Test mode field.
  5. Click the Save button.

The plug-in settings include the following parameters:

  • Field Status — to display the payment method by using ecommpay payment page on the site.
  • Parameters of ecommpay payment page operation while displaying:
    • Popup mode — the way of displaying the payment page in the popup or in the current tab.
    • Additional parameters — additional parameters of the payment page.

      A list of these parameters is available Parameters for opening payment form. When specifying two or more parameters, they must be entered with "&" as separator.

    • 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:
    • Payment Zone — regions where the payment method is available.
    • Set Order Status — status when payment is successful.
  • 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 osCommerce in the section Orders.

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

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 section Payment).


  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 osCommerce.
  2. Go to the section Modules > Payment.
  3. Select ecommpay in the list and click the Edit button.
  4. Configure the operational parameters:
    • Make sure, that True is selected in the field Status.
    • Select False in the field Test mode.
    • 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 Save button.

Usage

Once the plug-in is launched it operates autonomously.

We recommend that you control orders by reviewing the information in the section 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.

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 True is selected in the fields Status and Test mode, 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