Documentation Index
Fetch the complete documentation index at: https://docs.bitcoinflash.xyz/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Flash is a REST API that enables users to buy and sell Bitcoin (Satoshi) and purchase internet/airtime products using Mobile Money and the Lightning Network. The API is built with Laravel 10 and uses JWT for authentication.Base URL
/api/v1.
Key Features
JWT Authentication
Secure authentication using JSON Web Tokens with OTP email verification.
Buy & Sell Bitcoin
Convert between XOF (FCFA) and Satoshi at real-time exchange rates.
Mobile Money Payments
Deposit funds via MTN, Moov, and other mobile money operators.
Lightning Network
Fast Bitcoin payments via the Lightning Network.
KYC Verification
Multi-tier KYC system with document and selfie verification.
Architecture
The API follows a Domain-Driven Design (DDD) architecture:| Domain | Responsibility |
|---|---|
Auth | Authentication, OTP, JWT token lifecycle |
Transaction | Transaction history & status tracking |
Notification | Email & WhatsApp alerts |
Rate Limiting
| Route Group | Limit |
|---|---|
| Auth endpoints | 20 requests / minute |
| Authenticated endpoints | 60 requests / minute |
| Metrics | 30 requests / minute |