Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/own-pay/OwnPay-Documentation/llms.txt

Use this file to discover all available pages before exploring further.

The Plugins manager is the central hub for extending OwnPay beyond its core functionality. Every payment processor connector, utility addon, and checkout theme is packaged as a plugin and managed from this single screen. Extensions are grouped into three categories — Gateways, Addons, and Themes — and can be installed, activated, or deactivated without touching configuration files.
Plugins run under a secure sandbox (PluginSandbox or PluginLoader) to isolate third-party code. Manifest slugs in database records must match filesystem folder names exactly. Always source plugins from trusted publishers.

​
Accessing the Plugin Manager

1

Log in as Super-Administrator

Sign in to the OwnPay admin dashboard with your super-administrator credentials.
2

Open Plugins

In the left sidebar under the SYSTEM section, click Plugins.

​
Plugin Categories

The Plugins manager organizes extensions into filterable tabs:

Gateways

Payment processor connectors such as Aamarpay, SSLCommerz, and Stripe. Activating a gateway makes it available in the Payment Gateways configuration list.

Addons

Backend utility integrations: mail-gateway for transactional email, sms-gateway for SMS notifications, and telegram-bot for real-time payment alerts.

Themes

Visual checkout template packages that change the layout, animations, and styling of customer-facing checkout pages.

Trash

Plugins that have been uninstalled and are queued for permanent deletion from the server filesystem.

​
Plugin Card Overview

Each plugin is presented as a profile card displaying:
  • Branding Icon — the visual logo of the extension
  • Name & Type Tag — display name and type badge (Gateway / Addon / Theme)
  • Version & Description — package version number and a brief feature summary
  • Status Controls — Install & Activate button for inactive plugins, or Deactivate for active ones
  • Status Indicator — color-coded badge showing Active, Inactive, or Not Installed

​
Installing and Activating a Plugin

1

Browse or Search

Use the Search textbox or the Status dropdown to locate the plugin you want to enable (e.g., Telegram Bot).
2

Install & Activate

Click the Install & Activate button on the plugin card.
3

Automatic Setup

OwnPay extracts the package, runs any included database migrations, and updates the plugin’s status. Gateway plugins immediately appear in the Payment Gateways list for credential configuration.

​
Uploading a Custom Plugin

Developers can upload custom-built or third-party plugins as .zip archives directly from the admin panel.
1

Open the Upload Wizard

Click the Upload Plugin link in the Plugins page header.
2

Select the Archive

Choose a valid .zip plugin package from your local machine. The archive must contain a manifest.json at the root with a matching slug field.
3

Upload and Activate

Submit the form. OwnPay extracts the files, validates the manifest schema, and lists the new plugin in the appropriate category tab.
Never upload .zip archives from untrusted sources. Plugins run with administrative system permissions and have access to the database and filesystem. Only install plugins from publishers you trust.

​
Plugin Sandbox & Security

OwnPay enforces the following security constraints on all plugins:
The slug value in manifest.json must match the plugin’s filesystem folder name exactly. Mismatches prevent the plugin from loading and produce a manifest validation error in the admin panel.
Plugin logos are copied from the modules/ directory to the public assets directory on demand when the logo is rendered. Only image file extensions are accepted — non-image extensions are rejected automatically.

​
Best Practices

Deactivate any gateway or addon plugins you are not actively using. Inactive plugins do not load at runtime, which reduces memory overhead and speeds up each request cycle.
Review the version and compatibility notes in the plugin manifest description before uploading manual updates. Incompatible migrations can alter database schema in unexpected ways.
Plugin folder names must remain identical to their manifest slugs. Renaming them via FTP or a file manager causes database lookups to fail and can leave the plugin in an unrecoverable broken state.

Addons

Manage mail, SMS, and Telegram notification addon plugins.

Themes

Activate and manage checkout visual theme plugins.

Payment Gateways

Configure API credentials for activated gateway plugins.

System Update

Upload and apply core platform updates.

Build docs developers (and LLMs) love

Get started for freeTalk to us