How It Works
- From your infrastructure/application, call our Disbursements API with the recipient and payment details.
- We will process the disbursement and send the funds to the recipient’s mobile wallet.
- You’ll receive a webhook notification once the disbursement is completed or if it fails.
1. Prepare the disbursement details
First, you need to assemble the disbursement details. Here are the details you’ll need:| Field | Type | Description | Required |
|---|---|---|---|
amount | Number | The amount to disburse to the recipient. This should be in the lowest currency denomination (e.g., 10000 for 100.00) | True |
phoneNumber | String | The recipient’s phone number in international format without the + sign (e.g., “2257038102473”) | True |
currency | String | The currency in which you would like to disburse (e.g., “XOF”, “USD”, “NGN”) | True |
country | String | The 2-character country code for the recipient’s country (e.g., “CI” for Côte d’Ivoire, “NG” for Nigeria) | True |
reference | String | A unique reference code to identify this disbursement. This must be unique for every disbursement to prevent duplicate sends | True |
webhookURL | String | A URL where we will send disbursement event notifications. Highly recommended for tracking disbursement status | False |
2. Call the disbursements endpoint
To initiate the disbursement, call our Disbursements API with the collected details. Ensure you authorize the API call using yourx-api-key header.
API Endpoints
Sandbox (Testing): https://staging-api.mobipurse.com/v1/disbursements Production: https://api.mobipurse.com/v1/disbursementsRequest Headers
| Header | Description | Required |
|---|---|---|
x-api-key | Your Mobipurse API key from the dashboard | True |
Example Request
Currency & Country Codes
Common currency and country code combinations:| Country | Code | Currency | Example Amount |
|---|---|---|---|
| Côte d’Ivoire | CI | XOF | 200000 (2000.00 XOF) |
| Nigeria | NG | NGN | 50000 (500.00 NGN) |
| Ghana | GH | GHS | 10000 (100.00 GHS) |
| Kenya | KE | KES | 100000 (1000.00 KES) |
Need Help?
If you encounter any issues with the checkout integration:- 📧 Email: [email protected]
- 💬 Contact us through your merchant dashboard
- 📚 Browse our complete API documentation
