OPay WHMCS Plugin

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

Download

Store Preparation

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

Warning

Warning

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

Warning

Warning

You need to log in to the Dashboard.

  1. Get Merchant ID, Secret Key, Public Key for sandbox/production environment

    As shown in the figure below：Log in OPay account, switch to sandbox environment (Test Mode):

    2. OPay dashboard

  2. Click on Account Details:
    3. OPay dashboard account details

  3. Merchant ID is shown as below:
    4. OPay Merchant ID

  4. Please click API Keys & Web Hook to access Secret Key and Public Key:
    5. OPay API

  5. To get Merchant ID, Secret Key and Public Key for production environment, please switch to Live Mode and repeat the above three steps:
    6. WHMCS Store settings

  6. Well done! Now you're ready to setup your WHMCS store to start accepting payments through OPay.

Installation

This section illustrates the steps you need to follow to configure your WHMCS store.

  1. Downloadthe plugin.

  2. Upload the following files to your WHMCS modules/gateways folder:
    modules/gateways/opaybankcard.php
modules/gateways/opaymobilewallet.php
modules/gateways/opayreferencecode.php
modules/gateways/opayshahry.php
modules/gateways/opayvalu.php
modules/gateways/opaybankinstallment.php
modules/gateways/opay
modules/gateways/callback/opaybankcard.php
modules/gateways/callback/opaymobilewallet.php
modules/gateways/callback/opayreferencecode.php
modules/gateways/callback/opayshahry.php
modules/gateways/callback/opayvalu.php
modules/gateways/callback/opaybankinstallment.php

  3. Click on Addons->Browse->Payments
    4. WHMCS upload

  4. You can see six new apps displayed on the page
    5. WHMCS complete_installation

Note

Congratulations!

Your WHMCS store is now set up!

Configuration

  1. Click any app and the following pop-up window will be appeared. Click Active :
    2. WHMCS plugin module_install

  2. Please turn off debugging in production environment:
    3. WHMCS plugin bank_card

  3. Click the "Save" button after filling in complete

    4. fielddescriptionexample
    Display NameEnter your display nameOPay Mobile Wallet
    Admin UserNameYour admin accountOPay-admin
    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.281821060121381
    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.OPAYPUB16225195185940.26281585441314603
    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.OPAYPRV16225195185940.8419474371071703
    Order Expire TimePayment expiration in minutes.30
    Allow Debug ?Enable in case you are still in development phase. Disable debug when turning into production mode.Enabled/Disabled
    Convert To For ProcessingChoose your currencyEGP
    Note

    Congratulations!

    The OPay payment component installation is fully configured!

    Warning

    Warning

    The store country and monetary unit set up in the WHMCS must be consistent with the Merchant ID registered country.

What's Next?

Callback Notifications

Learn how to set up Payment Notifications Callback.

End-to-End Testing

Test your integration using End-to-End Testing.