Bitcoin payment plugin for WHMCS using the BTCPay Server.
Version 4 uses the official BTCPay Server Greenfield PHP library and signed webhooks.
Download the attached release ZIP for a ready-to-upload installation; dependencies
are included. Source checkouts require composer install.
Upgrading from version 3 requires a Greenfield API key and store ID. Save the
settings and wait for WHMCS to confirm success, then click Set up / repair
webhook beside Manual Webhook Secret or on the connection/recovery page.
This separate action registers the webhook and securely stores its
BTCPay-generated secret internally; saving settings alone does not register it.
Upload both modules/ and includes/ from the release ZIP and reload the gateway
settings page.
See the installation and upgrade guide, including recovery of payments
whose legacy notifications were missed. The legacy integration no longer works
with BTCPay Server 2.4.4 or later.
To get up and running with our plugin quickly, see the GUIDE here: https://github.com/btcpayserver/whmcs-plugin/blob/master/GUIDE.md
- PHP 8.1+ with bcmath, curl, json and mbstring
- WHMCS 9.0.6 was tested with v3; validate v4 on your staging installation
- GitHub Issues
- Open an issue if you are having troubles with this plugin
WHMCS Support:
- Ensure a valid SSL certificate is installed on your server. Also, ensure your root CA cert is updated. If your CA cert is not current, you will see curl SSL verification errors.
- Verify that your web server is not blocking POST requests from servers it may not recognize. Double-check this on your firewall as well, if one is being used.
- Check the version of this plugin against the official plugin repository to ensure you are using the latest version. Your issue might have been addressed in a newer version! See the Releases page for the latest.
- If all else fails, contact us using one of the methods described in the Support section above.
TIP: When contacting support, it will help us if you provide:
- WHMCS and BTCPay Server Plugin version
- PHP version used
- WHMCS logs and Web server error logs
- Screenshots of error messages
Would you like to help with this project? Great! You don't have to be a developer, either. If you've found a bug or have an idea for an improvement, please open an issue and tell us about it.
If you are a developer wanting to contribute an enhancement, bugfix or other patch to this project, please fork this repository and submit a pull request detailing your changes. We review all PRs!
This open source project is released under the MIT license which means if you would like to use this project's code in your own project you are free to do so. This plugin is forked from the BitPay WHMCS plugin.
Please refer to the LICENSE file that came with this project.