BTCPay Server

# Accept Bitcoin on your Drupal Commerce Store using BTCPay Server

Introducing BTCPay Server payment module for Drupal Commerce 2.x or 3.x (opens new window). Drupal Commerce Store owners can now accept payments using Bitcoin and other cryptocurrencies directly through BTCPay Server without any third-party intermediary.

BTCPay Server supports a wide range of cryptocurrencies, with the potential for future extensions. Here are the currencies you can use now on BTCPay Server:

  • BTC (Bitcoin)
  • Bitcoin layer-two network (the Lightning Network) for fast and zero/low-fee transactions
  • Altcoins with full node integration including coins like Monero (XMR) and Litecoin (LTC).
  • Other Major Altcoins: Supported through plugins via platforms such as Trocador, SideShift, and FixedFloat.

Want to accept Bitcoin on your Drupal Commerce store? Visit the project page on Drupal.org (opens new window)

# Requirements

# Upgrading

As of version 3.x of this module it uses the BTCPay Server Greenfield API which is much more powerful and allows more features. Version 3.x is a breaking change and also new libraries and API tokens are used. So please uninstall old versions (1.x and 2.x) before you install the latest 3.x release. And follow the setup instructions below.

# Installation and configuration Guide for the BTCPay Server - Drupal Commerce Integration

Ready to accept Bitcoin on your Drupal Commerce Store? Follow this quick and easy guide to install and configure the BTCPay Drupal Commerce module. For a quick run through, check out our installation and configuration screencast:

# Easy setup steps

# Prepare your BTCPay server store

  1. Setup your store: You'd need a BTCPay server instance to get started. Don't have one? click here for a step-by-step guide.
  2. Make sure you have setup at least Bitcoin or Lightning wallet.

# Commerce BTCPay: Installation + configuration

  1. Install module: composer require drupal/commerce_btcpay
  2. Enable the module: drush en commerce_btcpay -y
  3. Go to Commerce BTCPay configuration (Commerce -> Configuration -> Payment -> Payment gateways):
  4. Click on [Add payment gateway]
  5. Enter the BTCPay Server URL (e.g. https://btcpay.yourdomain.tld). (This is where you created your store, see requirements for how to setup a BTCPay Server.)
  6. You can now click Generate API Key and you will get redirected to BTCPay Server authorization page.
  7. Select the store you want to connect to and click [Continue]
  8. On the next screen enter a label e.g. "Drupal 11 store".
  9. At the bottom click [Authorize app]
  10. You will get redirected to your Drupal Commerce store and you should see that the store id, API key and webhook was saved.
  11. Done, you can now test the payment gateway.

# Status

This module is currently in alpha stage but has proven stable without issues.
Future updates and releases will be available on the project page on drupal.org (opens new window)

# About BTCPay Server

BTCPay Server (opens new window) is a self-hosted, open-source cryptocurrency payment processor know for its security, privacy, and censorship resistance.

It's free to use and allows you to become your own payment processor. To get a full overview about BTCPay Server, check out our documentationhttps://github.com/btcpayserver/commerce_btcpay/blob/master/.

# Get Support

You can open an issue on our Github repository (opens new window) or reach us on Telegram (opens new window) or Mattermost chat (opens new window)

← EasyWebshop →