In this article you will be going to know about:


TABLE OF CONTENTS

What is WordPress?

WordPress is an open-source software you can use to create a beautiful website, blog, or app. Beautiful designs, powerful features, and the freedom to build a website.


And by adding the WooCommerce plugin, you will be managing your e-commerce web store. 

How to integrate your WooCommerce platform with your ClickPay account?

By following below steps, you will integrate your system in no time, without even having a technical background.


Installing the Plugin

  1. Log in to your merchant dashboard. 
  2. Navigate to the Developers menu.
  3. Go to “WooCommerce” under the “PRE-BUILT INTEGRATIONS” section. 
  4. Click on the link “click here” as shown in the picture below.


  5. Then use one of the following methods to install the plugin:



Admin Panel

  1. Navigate to your WordPress admin panel > Plugins > Add New


  2. Once you get there, click on the “Upload Plugin” button.


  3. Choose your downloaded plugin from step 4, and click on the “Install Now” button. 


FTP

  1. Upload your downloaded plugin from step 4 to the "wp-content/plugins" directory within your WordPress installation.
  2. Extract the plugin file.


Activating the Plugin

You can activate your plugin either by:


After installing the plugin right away a screen will be displayed with a “Activate Plugin” button


Or by:


Navigate to your WordPress admin panel > Plugins > Installed Plugins > ClickPay - WooCommerce Payment Gateway


Configure the Plugin

  1. From your WordPress admin panel, navigate to Plugins > Settings
  2. Go to the tab “Payments”


  3. Select the preferred payment method from the listed available ClickPay payment methods.



  4. Enable the payment method by checking its option
  5. Choose your ClickPay endpoint region (the region your ClickPay account registered at)



  6. Enter your "Profile ID" and "Server Key" in the account information section on your configuration page. For more information about how to get your integration keys from your dashboard, please click here.


  7. Click on  “Save changes” button to save your configurations.


And here you are done installing ClickPay latest WooCommerce plugin, and you can run on the ground with your business. 


How to upgrade ClickPay plugin in WooCommerce to the latest version?

  1. Go to your WooCommerce admin panel and deactivate the old payment plugin, you already using for now then delete it. (From Plugins > Installed Plugins > ClickPay - WooCommerce Payment Gateway).
  2. Repeat the above steps on the "How to integrate your WooCommerce platform with your ClickPay account?" section.


What are ClickPay plugin configuration options?



Hide shipping Information Option

In case you want to not force the customers to reenter both billing and shipping information, you may like to enable it.


The customer details are still required and must be passed, in case any of the details are missing or passed with invalid values; the hide_shipping option will be ignored and cardholder will be required to enter any of the missing details on the payment page



Capture Order Status Option


This option controls what will be the order status on your system after it has been completed (authenticated/successful payment)



Be very careful when you change the Default option. Once you change it, you change the normal flow of the Order into the WooCommerce system, you may encounter some consequences based on the new value you set


Failed Order Status Option


This option controls will be the order status on your system if it's failed on the payment phase (declined/error/not a successful payment)



Be very careful when you change the Default option. Once you change it, you change the normal flow of the Order into the WooCommerce system, you may encounter some consequences based on the new value you set 




Allow IPN events Option


This is option allows you to synchronize your order events (Capture, Void, Full Refund, and Partial Refund) between your ClickPay account and your WooCommerce system. In other words, whenever you process a transaction from your ClickPay account, the action reflects the same order on your site as well.



You need to register an IPN in your dashboard first to allow this feature to function properly.

Then copy this link that the plugin shows as in the below image, provide the link in the IPN configuration in your dashboard and make sure to check/activate on the (Capture, Void, and Refund) events.



To know more about how to configure an IPN please check our How to configure Instant payment notification (IPN)? solution article.



Allow Associated Option


This is an option that is only available for cards payment methods such as Credit Cards, Mada, Meeza ones. 


Enabling this would allow displaying all available card payments (on your ClickPay merchant profile) on the ClickPay payment page.



Enable Tokenize Option 


In case you want to display the “Save to account”  button to allow your customer to save their payment methods for later use without navigating to the ClickPay payment page, it is used for subscriptions purposes.



Customer cards will not be saved if the payment failed, only a successful payment should save the card to the account.



Transaction Type Option


This option is not supported for all payment methods, it controls whether the transaction type is sale or auth.


Sale: Directly deduct the payment from the customer's bank account, credited to the merchant account. 


Auth: will be Authorized (hold) only on customer's account to be captured later,



This option is usually used with the next option (Auth order status: On Hold).
Capturing the earlier authorized transactions would be taken place on changing the status of the order from “On Hold” to “Competed”.
Also, could be captured manually from Merchant Dashboard on ClickPay.


Auth Order Status Option 


This option controls what will be the order status on your system after it has been authorized (authorized/successful payment)



This option only works if the "Transaction Type Option" was Auth



Payment form type Option 


This option has three values:


  • "iFrame payment form integrated into checkout" enables you to display the ClickPay payment page as apart from (within) the checkout page without needing to redirect the customer outside your website redirect him back again.
  • "Redirect to hosted form on ClickPay server" redirect the customer to ClickPay hosted payment page as usual.
  • "Managed form" on the payment page is displayed on your website. Whilst card details will not be handled by your system. For more information, please check our solution article Managed Form.



If you choose the iFrame payment form option, then we highly recommend to us HTTPS in your site. also We recommend the Managed form option method if you are PCI certified to a minimum of SAQ A-EP.


How to find log files to troubleshoot any issues?


In some cases, when you contact our technical support team for assistance, they require the log file to assist you accordingly (or even you may want to troubleshoot the plugin behavior yourself). You will be able to find those files at:


ClickPay custom log

It will be named as debug_clickpay.log file and will be found at “/wp-content/debug_clickpay.log”