> For the complete documentation index, see [llms.txt](https://developer.branta.pro/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.branta.pro/setup/platforms/payment-gateway-options/btcpay-server.md).

# BTCPay Server

[Official Plugin Link](https://plugin-builder.btcpayserver.org/public/plugins/branta): <https://plugin-builder.btcpayserver.org/public/plugins/branta>

{% embed url="<https://drive.google.com/file/d/1_EdWn0dtOxYfFZ4ZB0Ptaf2INf08FY8m/view?usp=share_link>" %}

## 1. Install Branta

[*Voltage*](https://www.voltage.cloud)*,* [*BTCPay Italia*](https://www.btcpayserver.it)*,* [*Bitcoin Aruba*](https://btc.aw) *and* [*pay.branta.pro*](https://pay.branta.pro/) *all have Branta installed already. If you run a hosted BTCPay Server and have Branta installed, open a* [*PR*](https://github.com/BrantaOps/branta-network) *to be added to our* [*Network Page*](https://branta.pro/network?tab=btcpay_server)*.*

* Login to BTCPayServer and click "Manage Plugins" on the lefthand side.

{% hint style="warning" %}
Note: If you don't see "Manage Plugins," you'll need an admin to do this for you.
{% endhint %}

* Search `Branta` and click `install`.

<figure><img src="https://2482615079-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWfLyw4XD5FjUVq3GxTZN%2Fuploads%2FimNqkT2IBFXrmiU0jMPH%2FScreenshot%202025-11-06%20140300.png?alt=media&amp;token=e2036d1f-b963-421e-ba15-aeddc8381f18" alt=""><figcaption></figcaption></figure>

* Your BTCPay Server will restart.
* The Branta plugin appears.

<div align="center"><img src="https://2482615079-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWfLyw4XD5FjUVq3GxTZN%2Fuploads%2FBicUPWEtbFChak02WVvK%2FScreenshot%202025-08-30%20at%2009.10.21.png?alt=media&amp;token=b35aac5a-4625-4ae7-9075-fc6b6adbaf0c" alt=""></div>

## 2. Enter API Key

* Wait for the server to restart
* Under plugins, click `Branta`.
* Copy the API Key from your Branta Dashboard to the API Key settings field.
* Click `Save`.

## 3. Enable Branta

* Toggle Branta on by clicking <kbd>Enable Branta</kbd>.
* To confirm Branta is wired up, issue a test invoice and look for the `Click to verify with Branta` link in checkout — covered in step 4.

<figure><img src="https://2482615079-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWfLyw4XD5FjUVq3GxTZN%2Fuploads%2Fz0spn4dt8O4e7wPVOWms%2FScreenshot%202025-11-06%20140810.png?alt=media&amp;token=17d2cb8e-e201-414e-b349-1f19bc246147" alt=""><figcaption></figcaption></figure>

## 4. Advanced settings (optional)

Expand the **Advanced** section on the settings page if you need to change defaults:

* **Enable Staging** + **Staging API Key** — point the plugin at `staging.guardrail.branta.pro` for testing. Use a staging-only API key.
* **Show Checkout Info on Verification Page** — include the invoice description on the Branta verify page.
* **Allow Guardrail Verification for** — TTL for each published destination. Options: 30 minutes (default), 4 hours, 1 day, 7 days.
* **Show Verify Link at Checkout** — toggle whether the `Click to verify with Branta` link appears on invoices.

## 5. Verify Branta is running

* Make a test invoice and you'll see `Click to verify with Branta`.
* You can also [QR scan](https://scan.branta.pro/scan) from your phone or compatible wallet

<figure><img src="https://2482615079-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWfLyw4XD5FjUVq3GxTZN%2Fuploads%2Fw93WqvI1LsSmU1e7IBvn%2Fbtcpay-btc.png?alt=media&amp;token=3ea97d6f-a712-49fb-84e0-91d49ba612a7" alt=""><figcaption></figcaption></figure>