Create a transfer
Create a transfer to one Mobile Money beneficiary.
Endpoint
Requires X-API-Key authentication.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
amount | integer | Yes | Amount in XAF. Must be between 500 and 1,000,000 and be a multiple of 50. |
name | string | Yes | Beneficiary name. |
phone | string | Yes | Beneficiary phone number in international format. |
service_mobile_code | string | Yes | The code_prefix returned by Get mobile services. |
succes | boolean | No | Sandbox-only simulation flag. |
Example request
For sandbox requests, optionally add "sandbox_status": "COMPLETE", "FAILED", or "TIMEOUT" to control the final simulated status. This field is ignored for production keys.
Response
The transfer is recorded first and then processed asynchronously. An initial INIT status means that the transfer has been accepted for processing; it does not mean that the money has already been delivered. Save the returned reference to reconcile the transfer with your own order or payment record.
Errors
400— invalid or missing request field;401— missing or invalid API key;404— organisation, balance, or mobile service unavailable;500— unexpected server error.