> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](https://docs.btcpayserver.org/TryItOut/) 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**.

![BTCPay Server account menu with API Keys highlighted](https://mintcdn.com/nango/K6m841_Q0Jj98N-O/api-integrations/btcpay-server/account_menu_api_keys.png?fit=max\&auto=format\&n=K6m841_Q0Jj98N-O\&q=85\&s=97ce1822ac6fff0312f8159d00b0e3c5)

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

![BTCPay Server API Keys page with the Generate Key button](https://mintcdn.com/nango/K6m841_Q0Jj98N-O/api-integrations/btcpay-server/api_keys_generate.png?fit=max\&auto=format\&n=K6m841_Q0Jj98N-O\&q=85\&s=59f5bf4e9cfa0688f6f01c735ee0718c)

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**.

![BTCPay Server Generate API Key form with a label and permission checkboxes](https://mintcdn.com/nango/K6m841_Q0Jj98N-O/api-integrations/btcpay-server/generate_api_key_form.png?fit=max\&auto=format\&n=K6m841_Q0Jj98N-O\&q=85\&s=7dcf1d084e40d2730c5e7c1d92f8e286)

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

![BTCPay Server confirmation banner showing the generated API key](https://mintcdn.com/nango/K6m841_Q0Jj98N-O/api-integrations/btcpay-server/api_key_created.png?fit=max\&auto=format\&n=K6m841_Q0Jj98N-O\&q=85\&s=a45cc5a16bf09c36ef1d833ada41e209)

### 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.

![BTCPay Server Connect UI form with the BTCPay Server Host and API Key fields](https://mintcdn.com/nango/K6m841_Q0Jj98N-O/api-integrations/btcpay-server/form.png?fit=max\&auto=format\&n=K6m841_Q0Jj98N-O\&q=85\&s=4e4e291f4b875ec1d04e435ca1033a48)

You are now connected to BTCPay Server.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.