OvoPay Addons

Add new features to OvoPay without touching any code.

Addons are optional packages that plug new features into your OvoPay installation. Each addon comes as a single ZIP file. You upload it from the admin panel and it is installed for you. Its menus, settings, notification templates, permissions and mobile app screens are all added automatically.

This page explains everything that is the same for every addon: installing, activating, updating, uninstalling and fixing common problems. Each addon also has its own guide (see Available Addons) that explains how to set it up and use it.

Available Addons

Open a guide to learn how to set up and use that addon.

RemitPay v1.1 Domestic and international remittance. Users send money abroad by bank transfer or cash pickup. Admins complete bank transfers and agents pay out cash pickups. For: Admin, User, Agent AutoPay v1.1 Automatic scheduled payments. Users set Send Money, Bank Transfer, bills, recharge, fees, donations and merchant payments to repeat on their own. For: Admin, User

Requirements

Check these before installing any addon.

OvoPay v2.1 or later. The Addon Manager is part of v2.1. If you are upgrading from an older version, finish the v2.1 update first.
The addon ZIP file you received after purchase, for example RemitPay.zip or AutoPay.zip. Upload it exactly as you received it. Do not unzip it.
Your purchase code and Envato username for the addon.
The PHP zip extension enabled on your server. Most hosting providers enable it by default.
Writable folders: core/addons, assets/addons and core/storage must be writable (permission 755).
A working cron job. Several addons do their work in the background, for example running scheduled payments or updating exchange rates. Check Settings > Security & Compliance > CRON Job Setting and make sure the cron command is added on your server.

Take a backup first. Back up your database and files before you install, update or uninstall any addon.

Install an Addon

Upload the ZIP from the admin panel. That is all.

Installation Steps:

Log in to the admin panel and go to Settings > Addon Manager.
Click Install New Addon. If no addon is installed yet, the button reads Install Your First Addon.
Enter your Purchase Code and Envato Username.
Choose the addon ZIP file in Addon ZIP File and submit.
A Setting up your addon progress window appears. Keep the window open until it finishes. It can take a moment on slower servers.
When it is done, the addon appears as a card in the Addon Manager with its version and an Active status. Its menu is now visible in the admin sidebar.

After Installing

A short checklist that applies to every addon.

Review the addon settings. Every addon installs with safe default values. Open the addon's Settings page in the sidebar and adjust them to suit your business. The addon's own guide explains each setting.
Check the module switch. Addons that add a feature for users or agents also add a switch under Settings > Manage Settings > Module Settings. New modules are switched on by default. Turn a module off to hide the feature from users or agents.
Give your staff access. The main admin has access to everything. For other staff, go to Manage Admin > Role & Permissions, edit a role and tick the new permissions the addon added.
Review notification templates. Addon emails, SMS and push messages are listed under Settings > Notification Setting > Notification Templates. Edit the wording there if needed.
Translate new words. The addon's words are added to your languages automatically. To translate them, go to Utilities & Report > Manage Language.
Check the cron job. If the addon has a background job, it appears under CRON Job Setting. Make sure it runs.
Mobile apps. The addon's screens show up in the mobile apps automatically, in the services area. You do not need to rebuild or republish the apps. Users may need to close and reopen the app once to see the new service.

Activate / Deactivate

Switch an addon off without losing any data.

Go to Settings > Addon Manager.
Find the addon card and use its Status switch.
Confirm the message that appears.

Deactivating hides the addon everywhere: admin menus, the user and agent panels, and the mobile apps. Its background jobs also stop. All of its data and settings are kept. Switch it back on at any time and everything is exactly as you left it.

Update an Addon

Install a newer version and keep all existing data.

When a new version is released, the addon card in Settings > Addon Manager shows Update available.
Download the new ZIP file, then click Update now on the card.
Drop the ZIP into the Upload Update Package window (or click to browse), then click Upload & Verify Update.
Keep the window open while the package is checked and installed. The card then shows the new version.

An update keeps all records, settings and edited notification templates. The package is checked first. It must be the same addon, and a newer version than the one installed.

Uninstall an Addon

Permanently remove an addon and everything it created.

Uninstalling cannot be undone. It deletes the addon's records (for example every remittance or every AutoPay schedule and its history), its settings, permissions, menus and files. Reinstalling later starts from scratch. If you only want to switch it off, use Deactivate instead.

Take a full backup of your database and files.
Go to Settings > Addon Manager.
Click Uninstall on the addon card.
Read the warning and click Yes, uninstall and delete everything.

Wallet transactions that already happened, such as money sent or payments made, stay in your users' transaction history.

Troubleshooting

Common messages in the Addon Manager and what to do.

Problem or message	What to do
Invalid addon package: config.json must be at the root of the ZIP, or no Source folder found	The ZIP was unzipped and zipped again, or the wrong file was uploaded. Upload the original ZIP you downloaded, without changing it.
The uploaded package arrived empty, or the upload stops or fails part-way	The file is larger than your server allows. Ask your hosting provider to raise `upload_max_filesize` and `post_max_size` (for example to 64M), then try again.
Could not open the ZIP file / The upload may be corrupt or incomplete	Download the ZIP again (the download may have been cut off) and upload the fresh copy.
The PHP zip extension is required to install addons	Enable the `zip` extension in your hosting control panel or `php.ini`, or ask your hosting provider to enable it.
...directory is not writable / could not be created / Please set permissions to 755	Set folder permission `755` on `core/addons`, `assets/addons` and `core/storage`. If a folder is missing, create it first. Then try again.
This addon requires core version ...	Your OvoPay is older than the addon needs. Update OvoPay to the required version first, then install the addon.
This addon requires the "..." addon to be installed first	Install the addon named in the message first, then install this one.
Purchase code is rejected	Copy the code again from your purchase page, with no spaces before or after it. Make sure it is the code for this addon, not for OvoPay itself, and that the Envato username is the account that bought it.
The installation window was closed, or the page was refreshed, before it finished	Open the Addon Manager again. If the addon card is there, deactivate it and activate it again. If it is not there, simply install the same ZIP again. Installing twice is safe and does not duplicate anything.
The addon is installed but its menu does not appear in the sidebar	Make sure the addon's Status is on. If you are logged in as staff, ask the main admin to give your role the addon's permissions under Role & Permissions. Then reload the page.
Users or agents cannot see the new feature	Check that the addon is active and that its switch is on under Module Settings. In the mobile app, close the app completely and open it again.
New words show in English on a translated site	Open Manage Language, choose your language and translate the new keys.
Background tasks (scheduled payments, rate updates) never run	The server cron job is not running. Open CRON Job Setting, copy the command shown there and add it to your server's cron (in cPanel: Cron Jobs). The page shows when each job last ran.
A blank page or "Server Error" after installing	Deactivate the addon from the Addon Manager to bring the site back. Then contact support with the addon name and version, and the time the problem started.

Support

How to get assistance

Still stuck? Email us with the addon name and version, your OvoPay version, the exact message you see (a screenshot helps) and the steps that lead to it. We are happy to help.