How it works
-
Get or create your wallet
Use the wallet API to get the business wallet for your integration. This gives you the wallet ID, account number, and current balances. -
Check available balance
Call the wallet‑balance endpoint to ensure you have enough available_balance to cover the transfer amount and any fees. -
Validate the destination account (optional but recommended)
Use the validate‑account endpoint (name enquiry) to confirm the destination bank account number and name before sending funds. -
Initiate the transfer
Call the Initiate Transfer API under Transfers with:- amount
- destination account number
- bank code
- narration / description
- a unique reference
- OTP or any required extra fields (depending on your risk settings)
-
Check transfer status
After you receive the initial response, use the transfer‑status endpoint (or webhooks, if enabled) to confirm whether the transfer ispending,success, orfailed. -
Reconcile wallet transactions
Use the wallet‑transactions endpoint to fetch a history of debits and credits for the wallet and reconcile payouts with your internal records.
Key considerations
- Idempotency: always send a unique reference per transfer so you can safely retry without doubling payouts.
- Limits and fees: design your UI to reflect any daily limits or per‑transfer caps enforced by your business rules.
- User experience: clearly communicate
pendingvssuccessto end‑users and surface clear error messages when a transfer fails.
For API payloads, headers, and response examples, see the Initiate Transfer reference and the wallet API references under Wallets.
