Developer documentation API v1
Build Bitcoin payments with confidence.
Create an invoice on your server, send your buyer to checkout, and reconcile the order from a verified webhook. For Live payments, SatLane derives receiving addresses from your registered extended public key. Your private keys stay in your wallet.
Start in Sandbox
Create your account, verify your email, set up two-factor authentication and create a store. On wallet-free Sandbox installations, you can create Test invoices without connecting a receiving wallet or sending Bitcoin.
For API integration, create a Test API key and send SatLane-Version: 2026-10-05 when creating an invoice at https://api.satlane.com/v1/invoices. Sandbox destinations have no payment address or wallet URI. Use the simulator to exercise payment outcomes; do not send real Bitcoin.
Read the quickstart for the setup steps and the environment guide for the wallet-free contract, compatibility errors and Live requirements.
Go Live when your store is ready
Configure and review your mainnet receiving wallet, complete the store's activation requirements, and use a Live API key. Switching the workspace view to Live does not activate payments. Your integration should verify signed webhook updates before fulfilling an order.
Use the addresses returned by the API for hosted checkout and other payment resources. Custom-domain stores may return their own checkout origin. For a self-hosted installation, use its configured dashboard and API URLs instead of the public SatLane domains.
Know what happens after payment
A customer can top up an underpaid invoice at the same address. The received balance and its confirmations are separate: wait for a verified paid event before fulfilling. Read the payment lifecycle guide for late, excess and reversed payments.
Account billing restrictions block new Live payment requests, while existing invoices continue processing. Read billing and locks for due dates, grace periods and recovery.
Find your next step.
One focused guide at a time.
Your first integration
Go from store setup to your first test invoice and verified event.
A checkout that fits
Use hosted checkout or build your own interface with live payment updates.
Know when it is paid
Verify signatures, handle repeat deliveries and reconcile your orders.
Handle the whole lifecycle
Understand confirmation, top-ups, expiry and recovery phases.
The API, clearly mapped
Find the invoice endpoints and their authentication boundaries.
Bring your AI assistant
Copy an integration brief and use the same guides as plain Markdown.
The starting point
An invoice.
A payment path.
Create on the server. Keep your API key there. Use test mode while building, then confirm the returned environment before proceeding.
Explore invoice creation ↗curl -X POST "$SATLANE_API_URL/v1/invoices" \
-H "Authorization: Bearer $SATLANE_API_KEY" \
-H "SatLane-Version: 2026-10-05" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: your-unique-order-id" \
-d '{"amount_sats":"100000","order_ref":"demo-order"}'