Using WooCommerce ECommPay for WordPress CMS

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

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

Operational scheme

Payments are processed by using ECommPay payment page, refunds are performed by using Refund via ECommPay option in WordPress Dashboard.



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:

  • On hold — payment is declined.
  • Processing without changing payment amount — payment is successful.
  • Processing 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 WordPress.
  2. Go to the Plug-ins section and click the Add New button.


  3. Click the Upload Plugin button.


  4. Select the archive with the plug-in and click the Install Now button.
  5. Once the plug-in is installed click the Activate Plugin button.


  6. Make sure, that message Plugin activated has appeared.


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, 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 WooComerce > Settings > Payments > ECommPay.
  2. Click the Manage 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 changes button.


Plug-in settings include the following parameters:

  • Checkbox Enable ECommPay—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.

    • Display mode—the way of displaying the payment page in the iframe object, popup or in the current tab.
  • 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 WordPress in the section WooComerce > Orders.

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

Performing test refunds

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

To perform refund you need:
  1. Go to the section Orders.
  2. Choose order you want to refund. The order status should be Processing or Completed.
  3. Click the Refund button.
  4. Enter the amount to refund.
  5. Click the Refund via ECommPay button.

After refund is performed the order amount should change on the refund amount, also message about performed operation should appear in Order notes.

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, 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 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 WordPress.
  2. Go to the following section WooComerce > Settings > Payments > ECommPay and configure the operational parameters:
    • Make sure, that Enable ECommPay checkbox is selected.
    • Clear the Test mode checkbox.
    • Fill in the Project ID and Secret key boxes with the values received from ECommPay technical support.
    • Make sure, that the remaining parameters are set to the required values.
  3. Click the Save changes button.

Using

Once the plug-in is launched it operates autonomously.

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

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 and Enable ECommPay checkboxes are enabled, 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