API reference
The Payout API lets external integrations discover Mobile Money services, create transfers, retrieve transfers, and submit bulk transfers.
Base URLs
Authentication
Authenticated endpoints require an API key in the X-API-Key header:
Create credentials from the client dashboard. See Create an API key.
The GET /services-mobile endpoint is part of the Developer API and also requires the API key.
Available endpoints
Mobile services
- Get mobile services — list services and their current active status.
Transfers
- Create a transfer — send money to one mobile-money beneficiary.
- List transfers — retrieve paginated transfers for the authenticated API key.
Bulk transfers
- Create a bulk transfer — submit several transfer items in one request.
Request and response format
Requests with a body must use JSON:
Successful responses use the resource-specific shapes described on each endpoint page. Validation and authentication errors follow this structure:
Pagination
Transfer lists accept page and size. Both values start at 1:
Paginated responses contain content, page, size, total, and, when applicable, next_page or previous_page.
HTTP status codes
| Status | Meaning |
|---|---|
200 | Request completed successfully. |
201 | Resource created successfully. |
400 | Invalid request or validation error. |
401 | Missing or invalid API key. |
403 | The API key is not allowed to perform the operation. |
404 | Resource or mobile service not found. |
500 | Unexpected server error. |