For the complete documentation index, see llms.txt. This page is also available as Markdown.

BTCPay Server

Official Plugin Link: https://plugin-builder.btcpayserver.org/public/plugins/branta

1. Install Branta

Voltage, BTCPay Italia, Bitcoin Aruba and pay.branta.pro all have Branta installed already. If you run a hosted BTCPay Server and have Branta installed, open a PR to be added to our Network Page.

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

  • Search Branta and click install.

  • Your BTCPay Server will restart.

  • The Branta plugin appears.

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 Enable Branta.

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

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 from your phone or compatible wallet

Last updated