OPay WooCommerce Plugin

The OPay Woocommerce plugin is not only designed to deliver the most convenient checkout experience, but is also developer friendly. This plugin integration is hassle free and comes with OPay's rich set of payment features. Please follow the steps outlined below and you can start accepting payments through OPay.

Note

Make sure you have an active OPay account or you can create an account.

In order to have a smooth and seamless integration, please make sure you have the following compatibility list satisfied.

This section illustrates how our gateway can be integrated with the WooCommerce plugin. Please follow the simple steps outlined below to integrate the OPay Woocommerce plugin with your WordPress/WooCommerce e-shop.

1. The first installation method：Zip package installation



2. Download the plugin.


3. Login to your WordPress Dashboard.


4. In your WordPress Admin Menu, go to Plugins => Add New.


5. Click on Upload Plugin button found on top left corner of page.



6. Click on Browse (1), select the .zip file of your plugin from your computer (2), and click Install Now (3) button.





Error

Renaming or other file manipulation on the downloaded plugin opay_woocommerce.zip file may cause the installation process to malfunction.



7. At this point, the plugin is installed. You can click on Activate Plugin link.



Warning

OPay plugin installation may encounter errors if WooCommerce was not installed properly. Please refer to the Before you start section for more information.



8. In your installed plugins, find OPay entry and click activate.

9. Well done, you have managed to install and activate Woocommerce OPay plugin!

1. The second installation method：WordPress market store installation

You can also install the plugin from the WordPress plugin store. We have configured the plugin to the App Market to provide you with a more convenient installation experience. The installation process is as follows:



2. Click on Plugin=>Add New.



3. Search for 'opay' in the search box as shown，then press enter.



4. Click 'Install now' to start installing the OPay plugin.



5. After installation, click 'Activate'.



6. Well done, you have managed to install and activate the WooCommerce OPay plugin!

1. Go to WooCommerce section.


2. Select Settings subsection.


3. In the settings page, click on the payment tab.


4. You will find five payment methods, which are Bank Card, OPay Reference Code, Shahry, ValU and Mobile Wallet.



5. Click on "Manage/Setup" button.



6. Within the "Manage" page, please fill the fields as described in the following table:

field	description	example
open OPay Payment	Enable or Disable OPay payment method.	Checked
Method Title	The title for the payment service to be displayed to your customers.	VISA | Meeza | MasterCard
Method Description	Payment service description to be presented to your customers.	OPay payment gateway supports Bank Card, Reference Code payment method etc.
Merchant ID	Your OPay account merchant ID (encrypted code) you should have received it after creating an account.	256612345678901
Secret Key	Your OPay account Secret key (encrypted code) you should have received it after creating an account.	Secret Key
Public Key	Your Sandbox Public key you should have received it after creating an account.	Public Key
Order Expiration Time	For example, if you enter 30, the unpaid order will be cancelled automatically after 30 minutes.	30
Auto Complete Order	If you are selling a virtual product, the status of the paid order will automatically change from Processing to Completed when checked.	Checked
Monetary Unit	Please select payment currency.	Select EGP
Test Mode	Tick this checkbox if you wish to test before going live. Untick to begin accepting payments with OPay.	checked






7. Once you're done, click on save changes button.


8. Enable both OPay payment methods and click save changes.





Congratulations!

Your WooCommerce E-shop is now ready to accept payments through the OPay payment gateway.



Warning

Supported payment methods:

• Bank Card
• OPay Reference Code
• Shahry
• ValU
• Mobile Wallet
• Bank Installment

1. Create a test order on your site and proceed to checkout page.


2. In your checkout page, OPay payment methods should be readily available to your customer.



3. Once you click on Place Order, OPay Cashier page will appear to your customer to complete the payments.



Note

For testing purposes, you may use any of our provided Test Cards.



4. Once your customer completes the payment, OPay Cashier will redirect your customer to the order received page.

1. Go to WooCommerce section.


2. Select Orders subsection.


3. In the orders page, you will find a list of your orders.



4. You will find the status of each order depending on the payment status. Note that in a case where your customer chooses to pay at any OPay POS, the status will be updated automatically once the payment has been done.



Payment Status	description
Cancelled	Cancelled Payment.
Pending Payment	The order is waiting payment by your client.
Processing	Payment done, however, it will be rendered processing until you change the order status to completed. You will need to do that in case of orders requiring shipping for example.
On Hold	Payment is on hold.
Completed	The payment has been completed.
Refunded	Refund has been issued to your customer.
Failed	The payment has been failed.

You can watch a step-by-step video tutorial for the plugin installation process here.