Using ECommPay payments for PrestaShop CMS

This manual describes how to use the ECommPay payments plug-in version 1.0. The plug-in allows you to perform payments and refunds by using ECommPay payment solutions for sites that are based on the PrestaShop CMS version 1.7 or later.

To download the plug-in ECommPay payments follow the here.

Operational scheme

Payments are processed by using ECommPay payment page, refunds are performed by using the Refund ECommPay command in the PrestaShop client interface.



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.
  • Approved without changing payment amount — payment is successful.
  • Approved with changing payment amount — partial refund is successful.
  • Refunded — full refund is successful.
  • Partially refunded — partial refund is successful.

Installing

To install a plug-in, do the following:

  1. Open PrestaShop.
  2. Go to the section IMPROVE > Modules > Modules & Services.
  3. Click the UPLOAD A MODULE button and select archive with the plug-in.


  4. Make sure that message Module installed! has appeared.


Testing

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

Configuration

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

  1. Go to the section IMPROVE > Modules > Modules & Services > Installed modules.
  2. Select ECommPay in the list and click the CONFIGURE button.
  3. Configure the required settings. For more details see below.
  4. Make sure that the Test mode checkbox is selected.

  5. Click the Save Settings button.

The plug-in settings include the following parameters:

  • 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.
    • Currency — a currency of the payment page.
    • Language — a language of the payment page.
    • 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 here. When specifying two or more parameters, they must be entered with "&" as separator.

  • 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 PrestaShop in the section SELL > Orders.

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

Performing test refunds

Once test orders are performed you should perform test refunds and check information regarding the refunds in PrestaShop in the section SELL > Orders.

To perform refund you need:
  1. Go to the section Orders.
  2. Choose order you want to refund. The order status should be Approved.
  3. Click the Partial refund button.
  4. Enter the amount to refund.
  5. Select the Refund ECommPay box and click the Partial refund button.

After refund is performed the order amount should change on the refund amount, also message A partial refund was successfully created should be displayed.

Note: The order status changes to Refunded, if full refund is performed. If partial refund is performed, the order status changes to Partially refunded.

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 you require 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 Configure).

  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 PrestaShop.
  2. Go to the section IMPROVE > Modules > Modules & Services > Installed modules > Configure.
  3. Configure the operational parameters:
    • Clear the Test mode box.
    • 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.
  4. Click the Save Settings button.

Using

Once the plug-in is launched it operates autonomously.

We recommend that you control orders by reviewing the information in the section SELL > 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 the Test mode checkbox is selected, 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 regarding the plug-in operation, contact ECommPay technical support at support@ecommpay.com.