Getting started
This documentation is for external developers integrating Mobile Money transfers with the Payout API.
The recommended integration path is:
1. Create an API key
Create a key from your client dashboard. Give it a clear name, then copy the generated API key and secret when they are displayed. The API key is used to authenticate API requests; keep both values private.
See Create an API key for the complete checklist.
2. Select the API environment
Create one API key for each environment. The key type selected in the dashboard determines the data, wallet, transfers and bulk payouts returned by the API; sandbox credentials never access production data.
3. Discover supported mobile services
Call Get mobile services and use the returned code_prefix as service_mobile_code when creating a transfer.
4. Send a transfer
Start with Create a transfer, then use List transfers to retrieve the transfers associated with your API key.
5. Add bulk transfers when needed
For several beneficiaries, use Create a bulk transfer. Each item is processed independently and the batch response includes aggregate counters.
API basics
The developer API is RESTful and uses JSON request and response bodies.
Send the API key with every authenticated request:
The mobile-services endpoint is authenticated and requires the same X-API-Key header.
Keep credentials safe
- Store the API key and secret in server-side secrets management.
- Never expose them in browser code, mobile applications, logs, or public repositories.
- Use separate sandbox and production credentials.
- Rotate a credential if it may have been exposed.