OPay WooCommerce Plugin

Throughout this page, you will learn how to install, configure, and activate OPay Woocommerce plugin. After following closely the steps explained in this tutorial, your Woocommerce shop will be able to start accepting payments through OPay payment channels.

Before you start

OPay Woocommerce plugin is not only designed to deliver the most convenient checkout experience, but also is meant to be developer friendly. Plugins integration is a hassle free process and comes with OPay rich set of payment features. No advanced development skills are needed. Follow closely the steps listed on this page and start accepting payments through OPay.

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

item compatible version References
Wordpress 5.1.1 or higher wordpress.org
PHP version 7.2.2 or higher wordpress.org
WooCommerce 3.6.1 or higher woocommerce.com
WooCommerce database 3.6.1 or higher woocommerce.com


This document illustrates how our gateway can be integrated with WooCommerce plugin in simple and easy steps. Please follow the steps in order to integrate OPay Woocommerce plug-in with your Wordpress/WooCommerce e-shop.

Installation methods are as follows:
  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. word press upload plugin screenshot
  7. Click on Browse (1), select the .zip file of your plugin from your computer (2), and click Install Now (3) button.
  8. Wordpress browse and install plugin screenshot
  9. At this point, the plugin is installed. You can click on Activate Plugin link.
  10. word press activate plugin screenshot
  11. In your installed plugins, find OPay entry and click activate.
  12. wordpress activate plugin click to activate screenshot
  13. Well done, you have managed to install and activate Woocommerce OPay plugin!
  1. The second installation method:Wordpress market store installation

  2. You also could install the plugin in 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:

  3. Click on Plugin=>Add New.
  4. word press upload plugin screenshot
  5. Search for 'opay' in the search box as shown,then press enter.
  6. word press upload plugin screenshot
  7. Click 'Install now' to start installing the OPay plugin.
  8. Wordpress browse and install plugin screenshot
  9. After installation, click 'Activate'.
  10. word press upload plugin screenshot
  11. Well done, you have managed to install and activate Woocommerce OPay plugin!

Set up and Configuration

  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. OPay Payment Methods
  6. Click on "Manage/Setup" button.
  7. OPay Payment Setup
  8. Within the "Manage" page, please fill the fields as described in the following table:
  9. 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
    OPay Secret Key & Merchant ID
  10. Once you're done, click on save changes button.
  11. Enable both OPay payment methods and click save changes.
  12. OPay Enable Payments

Verify your installation

  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. WooCommerce Checkout screenshot
  4. Once you click on Place Order, OPay Cashier page will appear to your customer to complete the payments.
  5. OPay Cashier
  6. Once your customer completes the payment, OPay Cashier will redirect your customer to the order received page.
  7. Order Received

Orders Management

  1. Go to WooCommerce section.
  2. Select Orders subsection.
  3. In the orders page, you will find a list of your orders.
  4. WooCommerce Order Status
  5. You will find the status of each order depending on the payment status. Note that, In case where your customer chooses to pay at any OPay POS, the status will be updated automatically once the payment has been done.
  6. 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.

Video Tutorial

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

What's Next?

User Profile 12 messages

James Jones
Application Developer
Recent Notifications
Another purpose persuade Due in 2 Days
Would be to people Due in 2 Days
The best product Due in 2 Days