Overview
The NGN payout process involves the following steps:- Get the list of supported Nigerian banks
- Validate the recipient’s bank account details
- Create a quote for the amount you want to pay out
- Pay the generated lightning invoice
- Receive webhook notifications for payment status
Prerequisites
Before you begin, ensure you have:- Created a Mavapay account
- Obtained your API key
- Set up your webhook endpoint
- Verified your business account
Authentication
All API requests must include your API key in the header:Getting Bank List
First, retrieve the list of supported Nigerian banks:Validating Bank Account
Before creating a quote, validate the recipient’s bank account details:Creating a Quote
Important Notes:- All amounts are in Kobo (1 NGN = 100 Kobo)
- Minimum payout amount is 2000 NGN
- To send 3000 NGN, use amount = 300000 Kobo
Understanding the Quote Response
usdToTargetCurrencyRate
: Price of 1 USD in NGNexchangeRate
: Price of 1 BTC in NGNamountInSourceCurrency
: Total amount in SATS to be paid (including fees)amountInTargetCurrency
: Total amount in Kobo to be sent to recipienttransactionFeesInSourceCurrency
: Fees in SATS (included in amountInSourceCurrency)transactionFeesInTargetCurrency
: Fees in Koboexpiry
: Invoice validity (5 minutes)customerInternalFee
: Optional extra fee you can charge (in SATS)
Webhook Events
You’ll receive two webhook events:payment.received
- When the lightning payment is receivedpayment.sent
- When the money is sent to the recipient’s bank account
payment.received Event
payment.sent Event
Checking Transaction Status
You can query transactions using the payment hash, orderId, or transaction ID:Getting Price Rates
To get current NGN rates:Testing
Use our staging environment for testing:- Account Number:
0149200000
- Bank: GTBANK PLC
- Bank Code:
000013
Support
If you need help with integration:- Email: info@mavapay.co
- Documentation: https://docs.mavapay.co
- API Reference: https://docs.mavapay.co/api-reference