Drupal

The project can be found here on drupal.org and therefore can be installed using composer from the drupal.org packagist (no need to add the repo manually to your composer.json). The sources are available on github.

Requirements

Module installation and configuration

Quick walkthrough screencast

Drupal Commerce

Quick walkthrough steps

Generate pairing code on BTCPay server

  1. in store settings go to "Access Tokens"

  2. click on [Create a new token]

  3. Label: enter some label (eg. my store)

  4. Public key: this needs to be left empty

  5. Facade: "merchant"

  6. click on [Request pairing]

  7. on next screen choose your configured store in Pair to select dropdown and click on [approve]

  8. note down the displayed 7-digit code at the top status message, e.g. "d7afaXr"

    (you will need that code below on gateway configuration, see below)

Commerce BTCPay: Installation + configuration

  1. install module: composer require drupal/commerce_btcpay

  2. enable the module: drush en commerce_btcpay -y

  3. make sure you have configured private file system (needed to store encrypted public+private key)

  4. Commerce BTCPay configuration (Commerce -> Configuration -> Payment -> Payment gateways):

  5. add payment method "BTCPay"

    • Mode: Test or Live (you can configure both individually)

    • Test/Live server host: enter your URL without https:// prefix e.g. btcpay.yourserver.com (note valid SSL certificate needed)

    • Test/Live Paring code: enter the 7-digit pairing code from BTCPay "Access tokens" page

    • Save

      You should see a message that the tokens were successfully created.