Practical overview
When it fits
Use it when you want to run a self-hosted Bitcoin payment processor for merchant payments, or when developing a payment integration around BTCPay Server.
Who it is for
- Merchants accepting Bitcoin for online sales, point-of-sale transactions or crowdfunding.
- Server operators deploying and operating a BTCPay Server instance.
- Developers building merchant integrations or plugins.
Documented uses
- Accept Bitcoin payments through an online checkout, point-of-sale workflow or crowdfunding checkout.
- Connect merchant software to BTCPay Server through its Greenfield API.
- Build a plugin that links merchant software with BTCPay Server.
Requirements & limits
The project describes itself as free, open-source and self-hosted, and identifies the MIT License. Its repository links to a demo.
- Self-hosting means the merchant or an operator must deploy and operate the application.
- The repository separates user, operator and developer documentation, reflecting different roles in using and maintaining the service.
- The Greenfield API is a documented integration route; a specific integration is not demonstrated by the available project information.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Create a Point of Sale app
Configure and open a BTCPay Server Point of Sale app for a store.
Before you start
- Access to a BTCPay Server instance with a store available to associate with the app.
Steps
Go to Apps and choose Create a new app.
Enter an app name, choose Point Of Sale as the app type, and select the store to associate with it.
Choose a view (Static, Cart, or Light) and add items with prices, photos, and descriptions as needed.
Click Save Settings, then View App to open the Point of Sale app.
Expected outcome
A Point of Sale app is available at the link shown through View App; customers can access it through that link.
Guide limitations
- The app must be connected to a store.
- The Light view is documented as available starting from version 1.0.5.6.
Create a crowdfunding app
Configure and open a self-hosted crowdfunding campaign in BTCPay Server.
Before you start
- Access to a BTCPay Server instance with a store available to associate with the app.
Steps
Go to Apps and create a new app.
Enter an app name, choose Crowdfund as the app type, and select the store to associate with it.
Add perks with prices, photos, and descriptions, and enable Allow crowdfund to be publicly visible if the campaign should be public.
Click Save Settings, then View App to open the campaign.
Expected outcome
The crowdfund app is available at the link shown through View App; contributors can access the campaign through that link.
Guide limitations
- The app must be connected to a store.
- Public visibility depends on enabling the corresponding option.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 13 October 2026
- Original website title
- btcpayserver/btcpayserver · Official homepage title · retained in its source language