API reference

The Payout API lets external integrations discover Mobile Money services, create transfers, retrieve transfers, and submit bulk transfers.

Base URLs

Production: <DeveloperApiUrl />
Sandbox:    <SANDBOX_API_URL>

Authentication

Authenticated endpoints require an API key in the X-API-Key header:

X-API-Key: <your_api_key>
Content-Type: application/json

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

Transfers

Bulk transfers

Request and response format

Requests with a body must use JSON:

Content-Type: application/json

Successful responses use the resource-specific shapes described on each endpoint page. Validation and authentication errors follow this structure:

{
  "statusCode": 400,
  "message": "Error description",
  "error": "Bad Request"
}

Pagination

Transfer lists accept page and size. Both values start at 1:

GET /api/transferts?page=1&size=10

Paginated responses contain content, page, size, total, and, when applicable, next_page or previous_page.

HTTP status codes

StatusMeaning
200Request completed successfully.
201Resource created successfully.
400Invalid request or validation error.
401Missing or invalid API key.
403The API key is not allowed to perform the operation.
404Resource or mobile service not found.
500Unexpected server error.