BTCPay Paymenter Gateway

BTCPay Server Payment Gateway for Paymenter

A simple extension to integrate BTCPay Server as a payment gateway within Paymenter, allowing you to accept cryptocurrency payments seamlessly and securely.

Supported Versions

• <b>Supported Version:</b> Paymenter V1 Beta
  
• <b>Extension Version:</b> v1.0.0
  

Features

• Accept Bitcoin (BTC) and other cryptocurrencies via BTCPay Server.
  
• Fully self-hosted payment processing for better privacy & security.
  
• Automatic invoice processing via webhooks.
  
• Custom Order Prefix support for better tracking.
  
• Secure transactions using BTCPay API Key & Webhook Secret.
  

Getting Started

• <b>Install the extension</b>
  [LIST]
  
• Replace /var/www/paymenter with your Paymenter root if it is different.
  
• <b>One-liner Install:</b>
  git clone https://github.com/VaibhavSys/BTCPay-Paymenter.git /var/www/paymenter/extensions/Gateways/BTCPay
  
• <b>Manual Install:</b><a href="https://github.com/VaibhavSys/BTCPay-Paymenter/releases/latest/download/BTCPay.zip" target="_blank" class="text-[var(--vp-c-brand-1)] hover:underline"> Download</a> the extension and extract it to:
  /var/www/paymenter/extensions/Gateways
  

[/LIST]

1. Enable the extension from the Paymenter admin panel.
   
2. Set up a webhook for <b>InvoiceSettled</b> (An invoice has been settled) event on https://your-paymenter.url/extensions/btcpay/webhook
   
3. Configure your BTCPay Server credentials and settings (see below).
   
4. Start accepting crypto payments via BTCPay Server!
   

[IMG alt="BTCPay Payment Page"]https://github.com/VaibhavSys/BTCPay-Paymenter/raw/v1.0.0/assets/payment.png[/IMG] [IMG alt="BTCPay Success Page"]https://github.com/VaibhavSys/BTCPay-Paymenter/raw/v1.0.0/assets/success.png[/IMG]

Configuration

To set up the extension, enter the following details in the Paymenter admin panel:

• <b>Instance URL:</b> Your BTCPay Server instance URL (e.g., <a href="https://btcpay.example.com" target="_blank" class="text-[var(--vp-c-brand-1)] hover:underline">https://btcpay.example.com</a>). Ensure no trailing slash.
  
• <b>Store ID:</b> Your BTCPay Store ID.
  
• <b>API Key:</b>API Key from BTCPay Server with the following required permissions:
  [LIST]
  
• btcpay.store.canviewinvoices
  
• btcpay.store.cancreateinvoice
  

Webhook Secret: Webhook secret used to verify payment notifications. This should match the one configured in BTCPay Server. Set up a webhook for InvoiceSettled (An invoice has been settled) event on https://your-paymenter.url/extensions/btcpay/webhook

Order Prefix (optional): Prefix added before the order ID (e.g. ORDER-10).
[/LIST]

<b>Note:</b> Ensure that the webhook is properly configured in your BTCPay Server to enable automatic invoice marking.

[IMG alt="BTCPay Settings"]https://github.com/VaibhavSys/BTCPay-Paymenter/raw/v1.0.0/assets/settings.png[/IMG]

Security Notice

This extension requires sensitive information, including:

• BTCPay API Key
  
• Webhook Secret
  

To keep your transactions secure:

• Always store these credentials securely and confidentially.
  

Support

For assistance, please reach out:

• <b>Discord:</b> <a href="https://discord.com/users/914452175839723550" target="_blank" class="text-[var(--vp-c-brand-1)] hover:underline">@vaibhavd</a>
  
• <b>GitHub Issues:</b> <a href="https://github.com/VaibhavSys/BTCPay-Paymenter/issues" target="_blank" class="text-[var(--vp-c-brand-1)] hover:underline">BTCPay-Paymenter Issues</a>
  

Additional Information

• <b>License:</b> This is an open-source extension licensed under the <a href="https://github.com/VaibhavSys/BTCPay-Paymenter/blob/v1.0.0/LICENSE" target="_blank" class="text-[var(--vp-c-brand-1)] hover:underline">MIT License</a>.
  
• The BTCPay Server name and logo are owned by BTCPay Server. This project is not affiliated with or endorsed by BTCPay Server.