Welcome to the Neutron API — a powerful infrastructure layer for sending, receiving, and managing Bitcoin and fiat payouts over the Lightning Network, on-chain Bitcoin, and local payout rails.
This overview gives you the big picture of how the system works, what you can build with it, and where to find key components in the documentation.
⚙️ What is Neutron API?
Neutron is a programmable money movement API designed for:
- Lightning-fast Bitcoin payments (both Lightning Network and on-chain)
- Fiat payouts to local banks and mobile money
- Stablecoin transfers (USDT on Tron and ETH)
- Currency conversion between BTC, stablecoins, and fiat
🔑 Authentication
All API requests require authentication via HMAC-SHA256 signatures. See Signature Generation for details.
💸 Transaction Flow
- Create a transaction via POST /api/v2/transaction
- Confirm it via PUT /api/v2/transaction/{id}/confirm
- Monitor status via GET /api/v2/transaction/{id}/status
📡 Webhooks
Set up webhooks to receive real-time notifications about transaction status changes.
📊 Exchange Rates
Get current BTC exchange rates via GET /api/v2/rates.