Setup
Pick the integration that matches what you're building.
Branta plugs into three places in the Bitcoin payments stack. Pick the one that matches your role — the onboarding requirements and integration shape differ.
For wallet developers who want their users to see who they are paying before broadcast.
Account required: None. Wallets read Branta data; they do not publish.
Integration: Drop in the SDK (
branta-js,branta-dotnet) and callgetPaymentsByQrCode/getPaymentsfrom your send flow.
For merchants, payment processors, and apps that issue Bitcoin payment destinations and want their counterparty info (name, logo) shown to senders.
Account required: Yes — sign up at guardrail.branta.pro, submit a platform request, and wait for approval.
Integration: Install a turn-key Payment Gateway (BTCPay Server, Zaprite, Take My Sats) — no code — or build a Custom Integration using the SDKs or raw HTTP.
For services that integrate Branta on behalf of many merchants and POST payments for each — typically multi-tenant payment apps like Zaprite or Take My Sats. Each merchant has their own Branta platform and API key; the parent service signs every request with its own HMAC secret to prove the call originated from it.
Account required: Yes — same flow as a regular platform, plus a Branta admin must enable the
parent_platformfeature on your account.Integration:
POSTto/paymentsusing the merchant's API key inAuthorization, signed with your HMAC secret inX-HMAC-Signature/X-HMAC-Timestamp.
Self-hosted, single-tenant deployments like BTCPay Server are not parent platforms — each BTCPay store is its own Branta platform with its own API key and no HMAC layer.
Using AI to implement?
Copy a prompt from the SDKs page and paste it into your AI agent. The prompts install the correct package and walk the agent through the Integration Guide automatically.
Not sure which one you are?
Building a wallet app
Running a single store or service that takes Bitcoin
Platforms — start with a Payment Gateway if one fits, else Custom Integration
Running a payment app that issues destinations on behalf of many merchants (ex: Zaprite, Take My Sats)
Last updated