OPay Opencart Plugin

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

Download

Before you start

The OPay payment integration with Opencart is simple and we've provided easy steps to help you get up and running!

Note

Note

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

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

itemcompatible versionReferences
Opencart3.0.x.x or higheropencart.com
PHP version7.4 or higher depending on your opencart versionopencart.com

Store Setup

This section illustrates the steps to configure your Opencart store. Please follow the simple steps outlined below to get your store ready for plugin installation.

  1. Login to your Opencart store admin panel.

  2. Click on System->Localisation->Currencies.
  3. Opencart dashboard
  4. Click on + to add new currency.
  5. Opencart add currency
  6. Enter currency information, set the currency status to Enabled, and then click Save.
  7. Opencart currency configuration
  8. Click on System->Settings, and then click on Edit to edit your store country and currency defaults.
  9. Opencart Store settings
  10. Change your store Country and Currency defaults and then click Save.
  11. Opencart Store settings
    Note

    Note

    Country and currency unit set for store in opencart has to be consistent with that of Merchant ID.


  12. Well done, you have successfully configured your Opencart store.

Installation

After completing the configuration, please follow the steps below to install OPay's Opencart plugin.

  1. Downloadthe plugin.

  2. Click on Extensions->Installer.
  3. Opencart dashboard
  4. Click on Upload. You will be asked to upload OPay plugin you have just downloaded.
  5. Opencart dashboard
  6. Select OPay Opencart plugin: opay-opencart.ocmod.zip and wait for the installation to finish once the upload has been completed.
  7. Opencart add currency
  8. Click on Extensions and enter the extensions configuration page.
  9. Opencart plugin activated feedback message screenshot

  10. Select Payments in the drop-down list and edit payment configuration.
  11. Opencart plugin activated feedback message screenshot

  12. Click on Extensions->Extensions, apply payment extensions filter, and scroll down until you see OPay payment methods.
  13. Opencart add currency

    Warning

    Warning

    Supported payment methods:

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


  14. Click on +, to install the payment method you wish to accept payments with.
  15. Opencart add currency

  16. Well done, you have successfully installed the OPay plugin in your Opencart store.

Configuration

  1. In your Opencart admin panel, navigate to Extensions->Extensions.

  2. In front of OPay logo, click on Edit.
  3. Opencart plugin activated feedback message screenshot

  4. Within the "Configuration" page, please fill the fields as described in the following table:
  5. Opencart plugin activated feedback message screenshot

    fielddescriptionexample
    Allow Debug ?Enable in case you are still in development phase. Disable debug when turning into production mode.Enabled/Disabled
    Accept (method) StatusControl whether OPay can be used as a checkout payment methodYes/No
    Merchant IDYour merchant ID you should have received it after creating an account. Set to your test merchant ID for testing, meanwhile, change for live merchant ID to start production mode.256612345678901
    Secret KeyYour Sandbox Secret key you should have received it after creating an account. Set to your test secret key for testing, meanwhile, change for live secret key to start production mode.Secret Key
    Public KeyYour Sandbox Public key you should have received it after creating an account. Set to your test public key for testing, meanwhile, change for live public key to start production mode.Public Key
    Method NameThe name to be displayed for your customers for this payment method.OPay Payments (Bank Card)
    Expire TimePayment expiration in minutes.30

  6. Once you're done, click on save changes button.
  7. Opencart plugin activated feedback message screenshot
  8. Repeat the above steps for the three payment methods provided from OPay.
  9. Note

    Congratulations!

    Your Opencart store is now ready to accept payments through OPay.

What's Next?