Accept Bitcoin Payments with Ease and no fees - BTCPay Server for WHMCS:

Accept Bitcoin Payments with Ease and no fees - BTCPay Server for WHMCS:

Developed By BTCPay Server

Compatible with WHMCS v8.9

This plugin allows you to easily start accepting Bitcoin payments in your using WHMCS BTCPay Server — a free, self-hosted and open-source Bitcoin payment gateway.

Features

  • 0% Fees: Enjoy a payment gateway with no fees. Yes, really!
  • No complicated KYC needed, you're your own self-hosted payment gateway
  • Automated invoice management and refunds
  • Simple and customizable checkout UX, available in 30+ languages
  • Direct payments to your wallet, no intermediary
  • Reporting and accounting – CSV exports
  • Real-time exchange price tracking for correct payment amounts
  • Community-driven support
  • Extensive documentation and video tutorials

Prerequisites

  • PHP version 8.1 or newer, lower versions may work but are not maintained
  • The curl, gd, intl, json, gmp (or bcmath) and mbstring PHP extensions are available
  • WHMCS
  • You have a BTCPay Server version 1.3.0 or later, either self-hosted or hosted by a third-party
  • You've a registered account on the instance
  • You've a BTCPay store on the instance
  • You've a wallet connected to your store

Quick Start Guide

To get up and running with our plugin quickly, see the GUIDE here.

Support

  • Last Version Tested: 8.6.0 RC1
  • GitHub Issues
    • Open an issue if you are having issues with this plugin

WHMCS Support:

  • Homepage
  • Documentation
  • SupportForums

Installation

Extract these files into the WHMCS directory on your webserver (parent directory of modules/folder).

Configuration

  1. Take a moment to ensure that you have set your store's domain and the WHMCS System URL under whmcs/admin > Settings Menu > Apps & Integrations.
  2. Create a "Legacy API Key" on your BTCPay Server store account dashboard:
  • Log into your BTCPay Server store with username/password.
  • On the left side of the screen, choose Settings.
  • Select the tab Access Tokens.
  • Below the "Legacy API Keys" headline click on the Generate button to instantly create a new one.
  • Select and copy the entire string for the new API Key ID that you just created. It will look something like this: 43rp4rpa24d6Bz4BR44j8zL44PrU4npVv4DtJA4Kb8.
  1. In the admin control panel, go to Settings > Apps & Integrations, on the top right searchbar, search for BTCPay. In the list of modules you will see "BTCPay Server (legacy API)".
  • If you can't find the BTCPay Server plugin in the list of payment gateways -or- in the WHMCS app store, then you may clone this repo and copy modules/gateways into your <whmcs root>/modules/gateways/.
  1. Paste the API Key ID string that you created and copied from step 2.
  2. Choose a transaction speed. This setting determines how quickly you will receive a payment confirmation from BTCPay Server after an invoice is paid by a customer.
  • High: A confirmation is sent instantly once the payment has been received by the gateway.
  • Medium: A confirmation is sent after 1 block confirmation (~10 mins) by the bitcoin network (recommended).
  • Low: A confirmation is sent after the usual 6 block confirmations (~1 hour) by the bitcoin network.
  1. Click Save Changes.

You're done!

Usage

When a client chooses the BTCPay Server payment method, they will be presented with an invoice showing a button they will have to click on in order to pay their order. Upon requesting to pay their order, the system takes the client to a full-screen invoice page of your BTCPay Server where the client is presented with payment instructions. Once payment is received, a link is presented to the shopper that will return them to your website.

NOTE: Don't worry! A payment will automatically update your WHMCS store whether or not the customer returns to your website after they've paid the invoice.

In your WHMCS control panel, you can see the information associated with each order made via BTCPay Server by choosing Orders > Pending Orders. This screen will tell you whether payment has been received by the BTCPay Server instance. You can also view the details for any paid invoice inside your BTCPay store dashboard under the Invoices page.

NOTE: This extension does not provide a means of automatically pulling a current BTC exchange rate for presenting BTC prices to shoppers. If you want to have a BTC currency in your installation, you must update the exchange rate manually.

Troubleshooting

  1. 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.
  2. Verify that your web server is not blocking POSTs from servers it may not recognize. Double check this on your firewall as well, if one is being used.
  3. 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.
  4. 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 is you provide:

  • WHMCS and BTCPay Server Plugin Version
  • Any log files that will help
    • WHMCS logs and Web server error logs
  • Screen grabs of error message if applicable.

Contribute

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.

License

This open-source project is released under the MIT license which means you are free to use this project's code in your own projects.

 

There are no reviews yet!

Be the first to review Accept Bitcoin Payments with Ease and no fees - BTCPay Server for WHMCS:.

Version Compatibility


Compatible with WHMCS v8.9

Full Version Compatibility


  • Selected versions of WHMCS v8.9
        8.9.0
  • Selected versions of WHMCS v8.8
        8.8.0
  • All versions of WHMCS v8.7
  • All versions of WHMCS v8.6

Support for this product

The best place to start if you need help with a specific product is to contact the developer. All WHMCS Marketplace developers have both a website and support URL listed.

Developed By BTCPay Server

Changelog

v3.1.0 Released October 20th, 2023

Latest Version


Accept Bitcoin Payments with Ease and no fees - BTCPay Server for WHMCS:

Overview

Introducing the BTCPay Server for WHMCS: your ultimate solution for accepting Bitcoin payments. Our plugin leverages the power and flexibility of BTCPay Server, enabling merchants on WHMCS to offer their customers a secure, private, and decentralized payment option. Whether you're looking to reduce transaction fees, eliminate chargebacks, or simply offer more payment options to your customers, BTCPay Server for WHMCS is designed to enhance your e-commerce experience.

Key Features

  • Zero fees: Enjoy a payment gateway with no fees. Yes, really!
  • Fully automated system: BTCPay takes care of payments, invoice management and refunds automatically.
  • Display Bitcoin QR code at checkout: Enhance customer experience with an easy and secure payment option.
  • No middlemen or KYC:
  • Direct, P2P payments (going directly to your wallet)
  • Self-hosted infrastructure: Maintain full control over your payment gateway.
  • Direct wallet payments: Be your own bank with a self-custodial service.
  • Accept payments in altcoins through various plugins
  • Elegant checkout design: Compatible with all Bitcoin wallets and enhanced with your store’s logo and branding for a unique UX.
  • Point-of-sale integration – Accept payments in your physical shops
  • Multilingual ready: Serve a global audience right out of the box.
  • Top-notch privacy and security: Protect your and your customers’ data.

Installation and Support

Using the BTCPay Server payment plugin for WHMCS

Prerequisites

Installation

Extract these files into the WHMCS directory on your webserver (parent directory of modules/folder).

Configuration

  1. Take a moment to ensure that you have set your store's domain and the WHMCS System URL under whmcs/admin > Settings Menu > Apps & Integrations.
  2. Create a "Legacy API Key" on your BTCPay Server store account dashboard:
  • Log into your BTCPay Server store with username/password.
  • On the left side of the screen, choose Settings.
  • Select the tab Access Tokens.
  • Below the "Legacy API Keys" headline click on the Generate button to instantly create a new one.
  • Select and copy the entire string for the new API Key ID that you just created. It will look something like this: 43rp4rpa24d6Bz4BR44j8zL44PrU4npVv4DtJA4Kb8.
  1. In the admin control panel, go to Settings > Apps & Integrations, on the top right searchbar, search for BTCPay. In the list of modules you will see "BTCPay Server (legacy API)".
  • If you can't find the BTCPay Server plugin in the list of payment gateways -or- in the WHMCS app store, then you may clone this repo and copy modules/gateways into your <whmcs root>/modules/gateways/.
  1. Paste the API Key ID string that you created and copied from step 2.
  2. Choose a transaction speed. This setting determines how quickly you will receive a payment confirmation from BTCPay Server after an invoice is paid by a customer.
  • High: A confirmation is sent instantly once the payment has been received by the gateway.
  • Medium: A confirmation is sent after 1 block confirmation (~10 mins) by the bitcoin network (recommended).
  • Low: A confirmation is sent after the usual 6 block confirmations (~1 hour) by the bitcoin network.
  1. Click Save Changes.

You're done!

Usage

When a client chooses the BTCPay Server payment method, they will be presented with an invoice showing a button they will have to click on in order to pay their order. Upon requesting to pay their order, the system takes the client to a full-screen invoice page of your BTCPay Server where the client is presented with payment instructions. Once payment is received, a link is presented to the shopper that will return them to your website.

NOTE: Don't worry! A payment will automatically update your WHMCS store whether or not the customer returns to your website after they've paid the invoice.

In your WHMCS control panel, you can see the information associated with each order made via BTCPay Server by choosing Orders > Pending Orders. This screen will tell you whether payment has been received by the BTCPay Server instance. You can also view the details for any paid invoice inside your BTCPay store dashboard under the Invoices page.

Using the BTCPay Server payment plugin for WHMCS

Prerequisites

Installation

Extract these files into the WHMCS directory on your webserver (parent directory of modules/folder).

Configuration

  1. Take a moment to ensure that you have set your store's domain and the WHMCS System URL under whmcs/admin > Settings Menu > Apps & Integrations.
  2. Create a "Legacy API Key" on your BTCPay Server store account dashboard:
  • Log into your BTCPay Server store with username/password.
  • On the left side of the screen, choose Settings.
  • Select the tab Access Tokens.
  • Below the "Legacy API Keys" headline click on the Generate button to instantly create a new one.
  • Select and copy the entire string for the new API Key ID that you just created. It will look something like this: 43rp4rpa24d6Bz4BR44j8zL44PrU4npVv4DtJA4Kb8.
  1. In the admin control panel, go to Settings > Apps & Integrations, on the top right searchbar, search for BTCPay. In the list of modules you will see "BTCPay Server (legacy API)".
  • If you can't find the BTCPay Server plugin in the list of payment gateways -or- in the WHMCS app store, then you may clone this repo and copy modules/gateways into your <whmcs root>/modules/gateways/.
  1. Paste the API Key ID string that you created and copied from step 2.
  2. Choose a transaction speed. This setting determines how quickly you will receive a payment confirmation from BTCPay Server after an invoice is paid by a customer.
  • High: A confirmation is sent instantly once the payment has been received by the gateway.
  • Medium: A confirmation is sent after 1 block confirmation (~10 mins) by the bitcoin network (recommended).
  • Low: A confirmation is sent after the usual 6 block confirmations (~1 hour) by the bitcoin network.
  1. Click Save Changes.

You're done!

Usage

When a client chooses the BTCPay Server payment method, they will be presented with an invoice showing a button they will have to click on in order to pay their order. Upon requesting to pay their order, the system takes the client to a full-screen invoice page of your BTCPay Server where the client is presented with payment instructions. Once payment is received, a link is presented to the shopper that will return them to your website.

NOTE: Don't worry! A payment will automatically update your WHMCS store whether or not the customer returns to your website after they've paid the invoice.

In your WHMCS control panel, you can see the information associated with each order made via BTCPay Server by choosing Orders > Pending Orders. This screen will tell you whether payment has been received by the BTCPay Server instance. You can also view the details for any paid invoice inside your BTCPay store dashboard under the Invoices page.

NOTE: This extension does not provide a means of automatically pulling a current BTC exchange rate for presenting BTC prices to shoppers. If you want to have a BTC currency in your installation, you must update the exchange rate manually.

Contribute and Collaborate

As an open-source project, BTCPay Server thrives on community contributions. Whether you're a developer looking to contribute code or a user with feedback and ideas, we welcome your participation. Help us make BTCPay Server for WHMCS even better!

Get Started Today

Join the growing number of merchants using BTCPay Server for WHMCS to offer their customers a modern, secure, and cost-effective payment solution. Visit our GitHub repository to download the plugin and follow our easy installation guide to set up your Bitcoin payment gateway today.

For more information, support, and resources, visit our official website and explore our comprehensive documentation. Welcome to the future of payments with BTCPay Server for WHMCS!

This format should make it easy to copy and paste directly into your project or documentation system.

 

See also

Accept Bitcoin and 70+ Cryptocurrency payments - CoinGate for WHMCS

Easily accept Bitcoin, Ethereum and many other crypto payments on your WHMCS website

Free
Account Statements Module

Send account statements to customers

Free
GST WHMCS Module For India

As WHMCS does provide tax rules options where you can configure your GST tax but we have some extra features in our module that makes it stand out and necessary to use.

Commercial
Discount Center For WHMCS

Introduce discounts applicable to orders of specified products combinations or quantities.

Commercial
Advanced Billing For WHMCS

Introduce extra billing models and charge your clients for actual server resource usage.

Commercial