# BTCPay plugin for SmartStore - accept Bitcoin payments

BTCPay Server SmartStore banner

# Plugin Overview

This plugin allows you to easily integrate Bitcoin payments into your SmartStore website using BTCPay Server — a free, self-hosted and open-source payment gateway solution designed to revolutionize Bitcoin payments. Our seamless integration with SmartStore ensures a hassle-free connection to your self-hosted BTCPay Server.

Experience the simplicity of accepting Bitcoin payments with just a few straightforward steps. You can configure the plugin either automatically or manually, depending on your preferences and requirements.

# Automatic Configuration

  1. Enter Url to your BTCPay Server into "BTCPay Url" field. (e.g. https://mainnet.demo.btcpayserver.org)
  2. Click on the "Configure automatically" button to be redirected to the API authorization page on your BTCPay server
  3. On BTCPay authorization page: Select the store you want to connect to your Smartstore (you might need to login first)
  4. Click on "Authorize App" button and you will be redirected back to your Smartstore
  5. The "API Key", "BTCPay Store ID" and "Webhook Secret" fields will be automatically filled and a webhook created
  6. Click "Save" button at the top right to persist the configuration
  7. Congrats, the configuration is now done.

# Manual Configuration

Ensure that the following fields are filled out: "BTCPay Url," "API Key," "BTCPay Store ID," and "WebHook Secret."

To create the BTCPay API key, read this.

  • Note: If you want to use the Refund feature, you must also add the "Create non-approved pull payments" permission. After a refund, an order note is created where you can copy the pull payments link and send to your customer. The customer can request the refund on that page.

To create the BTCPay WebHook, read this and use the default secret code generated by BTCPay.

  • Note: Other than in the guide you need to copy the Url shown in field "Webhook Url" from your configuration screen on Smartstore.

# Support

Feel free to join our support channel over at Mattermost Chat (opens new window) if you need help or have any further questions.

If experience a bug please open an issue in our repository here (opens new window)

# License

This plugin is released under the MIT License (opens new window).

Find our latest releases on the Smartstore marketplace (opens new window) or on our release page (opens new window)