BTCPay Server

# BTCPay Server Walkthrough

This page walks you through the BTCPay user interface and shows how to navigate through the different options in the sidebar.

Watch the video below for an interactive overview of the features.

After you've created an account on the BTCPay Server instance hosted by yourself or a third party, you'll be greeted by your store's new home or, as we call it, your dashboard.

BTCPay Server Navigation

Most settings in the left menu are connected to the current store you selected at the top. Some sections are only visible when your account has permission to use them. For example, Server Settings is only available to server admins, and individual plugins only appear after they are enabled for your store or installed on the server.

BTCPay Server Navigation

# Store

Inside BTCPay, you can create and manage an unlimited number of stores. Each store has its own wallet, can use plugins such as Point of Sale, Pay Button, and Crowdfunding, or be paired with external e-commerce software through one of the integrations available. Admins do not have control over the private keys of other users' stores. For more information, check Stores FAQ.

# Notifications

Notifications inform the user that an event has occurred on the BTCPay Server instance. Such event could be a received or failed payment, an overpaid or underpaid invoice, a new BTCPay version and more.

By clicking on the icon, you can access the Notifications page, where you can view past notifications and optionally delete them. Learn more about all BTCPay notifications here.

# Dashboard

In dashboard you will see the store's wallet balance, an overview of invoices, and a quick view of your crowdfunding top perks. There's 5 main tiles in the Dashboard.

  • A quick view on the wallet balance
  • Transaction and payout activity
  • Recent Transactions
  • Recent Invoices
  • Current running Crowdfunds

Continue to read more about Dashboard

# Wallets

# Bitcoin

Depending how many different payment methods you've setup, inside the wallets tab you'll see a wallet for each of the payment methods. Bitcoin on-chain wallet allows you to manage received funds. BTCPay's wallet is feature-rich and has privacy features built-in. Furthermore it has a full hardware wallet integration, so you can manage your funds with compatible hardware wallet directly from your BTCPay. Check wallet page for more information.

Elements of the internal BTCPay Wallet are:

  • Transaction - This shows your entire transaction history.
  • Send - Used for sending funds out of your wallet (has to be signed and confirmed on a compatible hardware wallet).
  • Receive - Used to generate a new address manually.
  • Rescan - Enables you to import old wallets into BTCPay more easily and solves the gap limit issue most external wallets have.
  • Pull Payments - Used to create and manage Pull Payments. For more information on this feature, check Pull Payments.
  • Payouts - Used to manage Pull Payment requests.
  • PSBT - Used to sign multi-signature transactions through the PSBT standard.
  • Settings - Used to view and adjust additional settings for your wallet.

# Lightning

Additionally, we recommend adding a lightning wallet. There are two options, connect an internal or connect an external Lightning node. Once completed, the Lightning wallet function becomes active.

For more information, check Wallet or Wallet FAQ

# Payments

# Invoices

All of the invoices for your user account will be displayed here. You can filter the invoices by the status, order, item, store or date. You can also create invoices manually. Invoices are sorted by date from new to old. You can open an individual invoice for more information. Use the export button to save a file (.json or .csv).

For more information, check Invoices

# Payment Requests

Each store can have an unlimited number of payment requests displayed here. Payment requests are dynamic invoices that can be shared by URL and paid at any time using current BTC exchange rates. Here you can edit and view your payment requests. You can see invoice details for your payment requests and clone previously created payment requests.

For more information, check Payment Requests

# Pull Payments

The feature of pull payments is one we see fit for options like A subscription service, refunds, time-based billing for freelancers, patronage, or a withdrawal service.

For a detailed description of the concept, please visit the Pull Payments

# Payouts

The payouts view gives an overview of the current pull payments and their status. If, for example, a refund has been issued and the claimant has accepted, this will show in Payouts. Here you will find the options to Approve and directly send the requested amount of the refund. When there are multiple instances of Pull payments, these can be selected and batched for sending out at once. In a future version, we expect this to have scheduling options.

BTCPay Server Navigation

# Pay Button

You can easily embed a donation or a payment button into an HTML of your website. When the customer or a visitor clicks on the button, BTCPay displays a checkout page and an invoice for them.

For more information, check Create a payment button

BTCPay Server Navigation

# Plugins

Plugins extend the use case of BTCPay Server beyond basic invoice payments. The default starting points are:

  • Point of Sale - accept payments from a physical store, event, or donation table.
  • Crowdfunding - run a self-hosted funding campaign where contributions go directly to your wallet.
  • Pay Button - embed a checkout button on your website.

Available plugins appear in the sidebar when they are installed and enabled. Server admins can manage plugin availability from Server Settings > Plugins; regular users can ask their server admin to enable a plugin for their store. You can also explore additional plugins in the BTCPay Server Plugin Directory (opens new window).

For more information, check Integrations or one of the prebuilt plugins like:

# Server settings

Server settings is something only a server admin can access. If you're using someone else's server, you won't see Server Settings. Inside the settings, you can perform tasks such as controlling users, rates, updating the server, etc. For more information, check Server Settings FAQ

  • Users - Add, remove or manage users of your BTCPay Server.
  • Email server - If you want users to verify their e-mail address when registering set up the SMTP settings.
  • Policies - Enable or disable user registration, e-mail verification, search engine indexing, and public display options.
  • Services - gRPC, REST, and RTL are used for connecting your LN node, SSH keys, and uploaded file storage setup.
  • Theme - Customize the front-end appearance of your BTCPay Server.
  • Maintenance - Update your BTCPay to the latest version and clean your BTCPay by deleting unused docker images.
  • Logs - Displays most recent logs of the BTCPay Server.
  • Files - After enabling this feature in Services, upload external files and access them via URL.

# Account

Manage your BTCPay Server account. Change anything related to your user-account. Setup Two-Factor Authentication and manage API keys.

# Join The BTCPay Community

If you have questions, try searching our FAQ Section or join the BTCPay Community and share questions and ideas for improvement.

If you are a developer, take a look at the Local Development guide and help us with any open issues (opens new window) on Github. If you would like to contribute to BTCPay in other ways, check out the Contribution Guide for ideas.

← Use Case →