# WHMCS

> Accept Ozow payments on WHMCS 8.0 and higher with the Ozow payment gateway module.

Source: https://hub.ozow.com/integration-methods/plugins-and-platforms/whmcs/

Accept Ozow payments on your WHMCS installation. The Ozow WHMCS payment gateway is compatible with
WHMCS 8.0 and higher.

> ℹ️ **Older versions**: Modules for older versions of WHMCS are available on request. Contact
> [support@ozow.com](mailto:support@ozow.com) or your account manager if you need a module for an
> older WHMCS version.

## Before you start

- You need an active Ozow merchant account. If you don't have one, sign up at [ozow.com/merchants](https://ozow.com/merchants).
- You need a working WHMCS 8.0 or higher installation.
- Requires PHP 7.2 or higher.
- Ozow only accepts payments in South African Rand (ZAR). Payments in other currencies are not supported.
- Back up your WHMCS files and database before proceeding.

## Download

[Download Ozow Gateway for WHMCS](https://ozow-live-cdn.s3.eu-west-1.amazonaws.com/plugins/WHMCS.zip)

## Installation

1. Download the plugin using the link above
2. Extract the zip file
3. Copy the `modules` folder into your WHMCS root directory, merge if prompted
4. Log in to your WHMCS admin area
5. Navigate to **Addons** → **Apps & Integrations**
6. Search for "Ozow" and click **Ozow Payment Gateway** to activate
7. Enter your merchant credentials, your site code, private key, and API key are available in your
   [Ozow Dashboard](https://dash.ozow.com)
8. Set **Test Mode** to **Yes** for testing or **No** for live payments
9. Click **Save Changes**

### Credentials

You will need the following from your [Ozow Dashboard](https://dash.ozow.com):

| Credential | Where to find it |
|---|---|
| API key | Merchant Details section |
| Private key | Merchant Details section |
| Site code | Site section |

## Upgrading from an older integration

If you are upgrading from the previous "iPay" gateway, remove the old iPay files before installing
the Ozow module to avoid conflicts. Delete the following files if they exist:

- `modules/gateways/ipay.php`
- `modules/gateways/ipaylib.inc`
- `modules/gateways/callback/ipay.php`

Once removed, follow the installation steps above.

## Uninstalling

To remove the Ozow gateway, deactivate it in your WHMCS admin and delete the following:

- `modules/gateways/ozow.php`
- The entire `modules/gateways/ozow/` directory and its contents

## Troubleshooting

**The gateway does not appear**: ensure the module files are in the correct location and that file
permissions are set correctly.

**Payments are not updating**: check the Gateway Log in your WHMCS admin and ensure your server can
reach Ozow's API endpoints. If you need to investigate further, enable **Debug Logging** in the
gateway settings to record detailed communication with Ozow.

> ⚠️ **Important**: Disable debug logging in your production environment once you have finished
> troubleshooting. Debug logs may contain sensitive information.

## Support

For assistance with your WHMCS integration contact [support@ozow.com](mailto:support@ozow.com) or
reach out to your account manager.