BTCPay Server

Self-hosted crypto checkout: server URL, store id, Greenfield API key, webhook secret. No sandbox toggle.

Settingbtcpay_checkout_enabled

BTCPay Server

Self-hosted crypto invoices via your BTCPay instance.

Where to find it

Admin → Settings → Payment → gateways → BTCPay Server

Setup

1. Set btcpay_server_url to your instance (https, no trailing slash). It must be reachable from this VPS and from customers.

2. Copy Store ID from Store → Settings → General.

3. Create a Greenfield API key with invoice create permission.

4. Create a webhook on that store for InvoiceSettled pointing to https://YOUR-DOMAIN/api/webhooks/btcpay and paste the webhook secret.

5. Enable checkout. Offered coins come from payment methods enabled on the BTCPay store, not from this admin form.

Official: BTCPay Greenfield API.

Field Key
Enable btcpay_checkout_enabled
Server URL btcpay_server_url
Store ID btcpay_store_id
API key btcpay_api_key
Webhook secret btcpay_webhook_secret

Return: /api/checkout/btcpay/return.

Common problems

Connection errors

Wrong URL, store id typo, or BTCPay down.

Invoice paid, site not upgraded

Webhook secret mismatch or webhook not on that store.

Related