DOCSEARCHbyAlgolia
Submit Docs

BTCPay Server Documentation

website·Indexed 39 days ago

https://docs.btcpayserver.org/

Documentation for BTCPay Server, a self-hosted Bitcoin payment processor. Includes guides on deployment, wallet setup, Lightning Network (LN) integration, and plugins like PodServer, Trocador, and VendorPay. Provides detailed integration instructions for e-commerce platforms including Shopify, Wix, WooCommerce, Magento, PrestaShop, and OpenCart, as well as API examples using cURL.

Tokens
117.5K
Snippets
398
Records
917
Agent score
74%

What's inside BTCPay Server

  1. Overview of Hack0 for BTCPay Server

    Hack0 is a hardware and operating system alternative to Raspberry Pi deployments. It simplifies the installation of BTCPay Server by providing a pre-configured environment for docker deployment. The project is maintained by DG Lab.

  2. Overview of PodServer for BTCPay Server

    PodServer is a plugin for BTCPay Server that allows users to self-host podcasts and implement Podcasting 2.0 features. It provides censorship resistance by giving the user control over the feed and files, and enables earning satoshis through Value-for-Value monetization. Key features include support for Podcasting 2.0 tags (Value, Person, Season) and the ability to import existing feeds.

  3. Overview of BTCPay Server features and architecture

    BTCPay Server is an open-source, self-hosted payment processor that enables direct peer-to-peer payments between merchants and customers without a third-party intermediary. Key architectural features include:

    • Non-Custodial: Merchants maintain full control of their private keys and funds; no KYC/AML requirements.
    • Zero Fees: No merchant processing, subscription, transfer, or software fees (users only pay standard Bitcoin network/miner fees).
    • Payment Support: Native Bitcoin support (including Segwit and Lightning Network via LND, CLN, or Eclair) and opt-in altcoin integrations.
    • Privacy & Security: Supports Tor, Payjoin, and prevents address re-use. It does not collect personal identification.
    • Integrations: Compatible with the BitPay API and integrates with CMS platforms like WooCommerce, Shopify, Drupal, Magento, Prestashop, OpenCart, and WHMCS.
    • Tooling: Includes a Point-Of-Sale (POS) interface for physical stores, crowdfunding tools, and embeddable HTML payment buttons.

  4. Overview of Electrum Personal Server (EPS) integration

    Electrum Personal Server (EPS) is a personal version of public Electrum servers (like ElectrumX) that allows users to verify their own transactions privately using their own full node. Unlike public servers, EPS is designed for monitoring only the user's own wallet(s) and requires the wallet's XPUB (extended public key) to function. EPS does not require txindex and is compatible with pruned nodes.

  5. Overview of adding an altcoin to BTCPay Server

    To integrate an altcoin into BTCPay Server, you must provide two components: a BTCPay Server plugin (for payment logic, wallet management, and UI) and a Docker Compose fragment (to deploy the coin's node infrastructure). Modifying the BTCPay Server core is prohibited; all new coins must be implemented as plugins.

  6. Overview of MultiSig support in BTCPay Server

    BTCPay Server (v2.1.0+) supports multi-signature (multisig) wallets, allowing for collaborative custody where multiple signatures are required to authorize a transaction. Key features include self-hosted coordination of public keys, integration with BTCPay Vault for hardware wallet support, an email notification system for pending signatures, and compatibility with plugins like Vendor Pay and Xpub Extractor.

  7. Overview of BTCPay Server Subscriptions

    BTCPay Server provides a unified subscription system for managing recurring payments (e.g., newsletters, SaaS, memberships). Since Bitcoin lacks a native 'auto-debit' mechanism, the system supports two payment models:

    1. Manual recurring payments: Customers receive a reminder and pay for each billing period manually.
    2. Automatic recurring payments: Uses a credit balance model where customers prepay funds, and renewals are automatically deducted from that balance.

  8. Overview of BTCPay Server Web Deployments

    A 'Web Deployment' refers to a third-party hosted environment where a service provider supplies the storage, compute power, and hosted Bitcoin nodes. This removes the need for the user to buy, host, and maintain their own hardware, though it introduces a trust factor regarding the host provider.

  9. Overview of LNDhub API plugin for BTCPay Server

    The LNDhub API plugin adds a LNDhub-compatible API to a BTCPay Server store. This allows the store's Lightning wallet to be imported into compatible wallet apps. Enabling this plugin provides full access to the Lightning node connected to the store, not just BTCPay Server-related activity.

  10. Overview of BTCPay Server

    BTCPay Server is a free, open-source, non-custodial cryptocurrency payment processor. It allows merchants and content creators to receive payments in Bitcoin (on-chain and via the Lightning Network) and altcoins directly into their own wallets without fees, transaction costs, or third-party middlemen. Because it is self-hosted, it increases censorship-resistance, privacy, and security.

  11. Overview of BTCPay Server Docker Deployment

    The official Docker deployment of BTCPay Server is managed via a stack that includes required components, data flow management, and optional services. The deployment process covers installation, server specification requirements (CPU, memory, storage, bandwidth), and architectural setup. Key management areas include environment variable configuration, networking (HTTPS, reverse proxies, tunnels), Lightning network implementation (CLN, LND, or Phoenixd), and cryptocurrency chain selection.

  12. Overview of BTCPay Server

    BTCPay Server is a free, open-source, self-hosted bitcoin payment gateway. It allows individuals and businesses to accept bitcoin payments online or in person without processing fees, middlemen, or KYC requirements. It is non-custodial, meaning the user maintains complete control over their private keys.