Mirror of a FOSS payment processor, alternative to Stripe, PayPal and more...
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
nicolas.dorier af97e296ba
16 hours ago
.circleci make sure tests run on latest images 3 weeks ago
.github/ISSUE_TEMPLATE Create feature_request.md 6 months ago
BTCPayServer Updating BundlerMinifier (#1033) 2 days ago
BTCPayServer.Common Excerpts from #971 (manual PR) (part1 ) (#1006) 1 week ago
BTCPayServer.Data Make tests more resilient 1 week ago
BTCPayServer.Rating add Ndax rate provider 1 week ago
BTCPayServer.Tests Checkout: show red border around email when invalid (#1013) 2 days ago
Build bump 16 hours ago
.dockerignore Remove launch profile from docker 1 year ago
.editorconfig Adopt dotnet core editorconfig, big reformating 1 year ago
.gitattributes shebang and fix line ending 1 year ago
.gitignore add .vscode to .gitignore 1 year ago
LICENSE new year 8 months ago
Nuget.Config Add Polis 1 year ago
README.md Add dev env videos to readme (#964) 3 weeks ago
amd64.Dockerfile fix dockerfiles 1 week ago
arm32v7.Dockerfile fix dockerfiles 1 week ago
btcpayserver.sln [Refactor] Move SQL classes in their own assembly 2 weeks ago
build.ps1 chmod +x scripts 1 year ago
build.sh shebang and fix line ending 1 year ago
docker-entrypoint.sh Revert "Do not use /sbin/ip to fetch the current ip (fix #712)" 5 months ago
publish-docker.ps1 Move Common and Version.csproj in Build folder 2 months ago
run.ps1 chmod +x scripts 1 year ago
run.sh fix run.sh 1 year ago


BTCPay Server

Docker Automated build Deploy to Azure CircleCI

BTCPay Server


BTCPay Server is a free and open-source cryptocurrency payment processor which allows you to receive payments in Bitcoin and altcoins directly, with no fees, transaction cost or a middleman.

BTCPay is a non-custodial invoicing system which eliminates the involvement of a third-party. Payments with BTCPay go directly to your wallet, which increases the privacy and security. Your private keys are never uploaded to the server. There is no address re-use, since each invoice generates a new address deriving from your xpubkey.

The software is built in C# and conforms to the invoice API of BitPay. It allows for your website to be easily migrated from BitPay and configured as a self-hosted payment processor.

You can run BTCPay as a self-hosted solution on your own server, or use a third-party host.

The self-hosted solution allows you not only to attach an unlimited number of stores and use the Lightning Network but also become the payment processor for others.

Thanks to the apps built on top of it, you can use BTCPay to receive donations, start a crowdfunding campaign or have an in-store Point of Sale.

What is BTCPay

Table of Contents


  • Direct, peer-to-peer Bitcoin and altcoin payments
  • No transaction fees (other than those for the crypto networks)
  • No processing fees
  • No middleman
  • No KYC
  • User has complete control over private keys
  • Enhanced privacy
  • Enhanced security
  • Self-hosted
  • SegWit support
  • Lightning Network support (LND and c-lightning)
  • Tor support
  • Full compatibility with BitPay API (easy migration)
  • Process payments for others
  • Easy-embeddable Payment buttons
  • Point of sale app
  • Crowdfunding app
  • Payment requests
  • Internal Web Wallet

Getting Started

Firstly, decide if you want to host an instance yourself or use a third-party host. If you’ve chosen to self-host, we documented plenty ways to deploy BTCPay Server.

After successful deployment, make sure to check our getting started and walkthrough guides. In case you would like to use Lightning Network, see Lightning guide.


Please check out our official website, our complete documentation and FAQ for more details.

If you have trouble using BTCPay, consider joining communities listed on official website to get help from BTCPay community members. Only file Github issue for technical issues you can’t resolve through other channels or feature requests you’ve validated with other members of community.

Main community chat is located on Mattermost.


BTCPay is built and maintained entirely by volunteer contributors around the internet. We welcome and appreciate new contributions.

If you’re a developer looking to help, but you’re not sure where to begin, check the good first issue label, which contains small pieces of work that have been specifically flagged as being friendly to new contributors.

Contributors looking to do something a bit more challenging, before opening a pull request, please create an issue or join our community chat to get early feedback, discuss best ways to tackle the problem and to ensure there is no work duplication.

You also have an awesome video of our contributors which explains how to get started.Rockstar Dev and Britt Kelly - Btc Pay Server Code Along

How to build

While the documentation advises to use docker-compose, you may want to build BTCPay yourself.

First install .NET Core SDK v2.1.9 as specified by Microsoft website.

On Powershell:


On linux:


How to run

Use the run scripts to run BTCPayServer, this example shows how to print the available command line arguments of BTCPayServer.

On Powershell:

.\run.ps1 --help

On linux:

./run.sh --help

How to debug

If you want to debug, use Visual Studio Code or Visual Studio 2017.

You need to run the development time docker-compose as described in the test guide.

You can then run the debugger by using the Launch Profile Docker-Regtest on either Visual Studio Code or Visual Studio 2017.

If you need to debug ledger wallet interaction, install the development time certificate with:

# Install development time certificate in the trust store
dotnet dev-certs https --trust

Then use the Docker-Regtest-https debug profile.

Other dependencies

For more information, see the documentation: How to deploy a BTCPay server instance.

Supported altcoins

Bitcoin is the only focus of the project and its core developers. However, opt in integrations are present for several altcoins:

  • Bitcore (BTX)
  • Dash (DASH)
  • Dogecoin (DOGE)
  • Feathercoin (FTC)
  • Groestlcoin (GRS)
  • Litecoin (LTC)
  • Monacoin (MONA)
  • Polis (POLIS)
  • Viacoin (VIA)
  • BGold (BTG) (also known as Bitcoin Gold)
  • BPlus (XBC) (also known as Bitcoin Plus)

Altcoins are maintained by their respective communities.