Two Ways to Off-ramp
| Method | How it works | Best for |
|---|---|---|
| Lightning Connection | Permanent standing order. Send sats to a Lightning address, EUR arrives in a bank account via SEPA. | Recurring off-ramps, automated payouts |
| Debit Card Top-up | One-off deposit. Send BTC on-chain, EUR loads onto a Bringin debit card. | Spending at merchants, ATM withdrawals |
Lightning Connection (BTC → EUR via SEPA)
A connection is a permanent link between a Lightning address and a bank account. Once active, every payment to the Lightning address is automatically converted to EUR and sent via SEPA. No further API calls needed.Step 1: Get the API Key
- Via API (if you have a backend)
- From Dashboard (if you don't have a backend)
Call You receive the api-key via the See API Keys for the full onboarding flow.
POST /application/connect with the user’s email. Bringin onboards the user and sends the per-user api-key to your webhook callback.Request
/verification-status webhook once the user completes signup and KYC./verification-status webhook
Step 2: Create the Lightning Connection
Once you have the api-key, create the connection using the BringinLink API. 1. Create the connectionRequest
Response (202)
status: "PENDING" and grab the challengeId from the standing order.
Response
Request
ACTIVE. Every Lightning payment to the address triggers automatic conversion and SEPA payout.
4. List connections
Debit Card Top-up (BTC → EUR on Card)
Send BTC to a deposit address — on-chain or via Lightning. Bringin converts to EUR and loads the balance onto the user’s debit card. Spend anywhere or withdraw at an ATM.1. Get the BTC/EUR Rate
Request
Response
bringinPrice is the rate after fees — what the user actually gets.
2. Get a Deposit Address
- Lightning
- On-chain
Request
Response
3. Check Balance and Transactions
Request
Response
Webhooks
All webhooks fire to thecallback URL you provided. Bringin appends the event path.
| Webhook | Fires when |
|---|---|
/verification-status | User completes KYC. Contains the per-user apikey. |
/order-status | Debit card top-up succeeds or fails. |
/connection-status | Lightning connection becomes active. Contains the lnAddress. |
Authentication
All requests require anapi-key header.
Getting Your API Key
Your users can grab their API key from the Bringin Dashboard under the Integrations tab. Click on the partner integration to reveal the key.
- Production: app.bringin.xyz
- Sandbox: dev-app.bringin.xyz
Key Types
| Key | Use |
|---|---|
| Master key | POST /application/connect, rate checks |
| Per-user key | Creating orders, managing connections, checking balance |
Per-user keys have limited permissions — they can only push crypto for conversion. Safe to store on client devices.
POST /application/connect with a callback URL. See HMAC Signing.
Testing
| Item | Value |
|---|---|
| API Base URL | https://dev.bringin.xyz |
| Dashboard | dev-app.bringin.xyz |