BTCPay Server - How do I link my account?

Overview

To authenticate with BTCPay Server, you need:

1. BTCPay Server Host — the host of the BTCPay Server instance you use.
2. API Key — a Greenfield API key from your BTCPay Server account.

This guide will show you how to find both.

Prerequisites

• An account on a BTCPay Server instance: your own self-hosted server, a third-party host, or the BTCPay Server demo server for testing.

Step 1: Find your BTCPay Server host

1. Open your BTCPay Server instance in your browser and sign in.
2. Copy the host from the address bar: the part after https:// and before the first /. For example, if you sign in at https://btcpay.example.com/login, your host is btcpay.example.com.

Step 2: Generate an API key

1. Open the account menu in the top-right corner and click API Keys.

2. On the API Keys page, click Generate Key.

3. Enter a label (for example, nango) and tick the permissions your integration needs, such as View your profile, View your stores and View invoices. Then click Generate API Key.

4. Copy the API key from the confirmation banner. You can show it again later with Reveal in the keys table.

Step 3: Enter your credentials in the Connect UI

1. Open the form where you need to authenticate with BTCPay Server.
2. In BTCPay Server Host, enter the host from Step 1 (for example, btcpay.example.com).
3. In API Key, paste the API key from Step 2.
4. Submit the form. Nango checks the API key with your BTCPay Server instance before saving the connection.

You are now connected to BTCPay Server.