title: “WHMCS Integration - Accept Payments on Hosting Invoices” description: “Install and configure the official OwnPay WHMCS payment gateway module to accept card and mobile wallet payments on hosting invoices.” keywords: “WHMCS payment module, hosting invoices, WHMCS gateway, card payments, WHMCS integration” sidebarTitle: “WHMCS”
WHMCS Integration
This is the official OwnPay WHMCS module for integrating with the WHMCS billing platform.
OwnPay on WHMCS Marketplace
Download the official OwnPay module from the WHMCS Marketplace.
Source Code on GitHub
View the open-source code, report bugs, or contribute on GitHub.
Prerequisites
Before starting, ensure you have:- A working installation of WHMCS (v8.0 or higher recommended)
- A self-hosted OwnPay instance running
- An OwnPay API Key and Webhook Secret from the OwnPay Admin > Developer Hub
Installation
1
Download the moduleDownload the latest release ZIP from the OwnPay-WHMCS Releases page.
2
Extract filesExtract the archive. You will see a
modules directory structure containing the gateway files:modules/gateways/ownpay.phpmodules/gateways/callback/ownpay.php
3
Upload to WHMCSCopy these files to your WHMCS root directory, preserving the folder structure:
Configuration
Once the files are uploaded, configure the module in your WHMCS Admin Area:1. Enable the Gateway
- Log in to your WHMCS Admin Area
- Navigate to System Settings > Payment Gateways (or Setup > Payments > Payment Gateways)
- Under the All Gateways tab, click OwnPay to activate it
2. Configure Gateway Fields
Under the Manage Active Gateways tab, fill in the configuration details:- Standard Settings
- Webhook & Test Settings
- Display Name: The name shown to clients on checkouts (e.g.
Credit/Debit Card / Mobile Banking (OwnPay)) - Api URL: The base URL of your self-hosted OwnPay instance (e.g.
https://pay.yourdomain.com) - Api Key: The API key generated from Admin > Developer Hub in OwnPay
Webhook Callback Configuration
OwnPay uses webhooks to inform WHMCS instantly when a customer completes their payment.1
Locate your callback URLYour WHMCS callback URL is:
Replace
your-whmcs-domain.com with your actual WHMCS domain.2
Create the webhook in OwnPayGo to your OwnPay Admin Portal > Developer Hub > Webhooks and click Add Webhook:
- URL: Paste your WHMCS callback URL
- Events: Select
payment.intent.completed
3
Link the signing secretCopy the generated Signing Secret from the OwnPay Admin portal and paste it into the Webhook Secret field of your WHMCS gateway settings. Save changes in both portals.
Troubleshooting & Logs
If payments are not being applied to invoices automatically:- Navigate to WHMCS Admin > Billing > Gateway Log
- Look for entries labeled
ownpayto see request/response details and signature validation errors - If signature verification fails, check that the Webhook Secret matches the Signing Secret in the OwnPay Admin portal exactly