Skip to navigation

Payouts

Send funds directly to a Tanzanian mobile money wallet. Payouts leave the merchant wallet the moment they are confirmed.

Send a payout

POST /api/v1/disbursements
x-api-key: sk_live_...
Content-Type: application/json
{
"amount": 50000,
"currency": "TZS",
"destinationType": "mobile_money",
"destinationDetails": {
"phoneNumber": "255742000331",
"network": "Mpesa",
"accountName": "Jane Doe"
}
}

Response:

{
"disbursement": {
"id": "...",
"status": "completed",
"amount": 50000,
"currency": "TZS"
}
}

Parameters

FieldTypeRequiredDescription
amountintegerYesAmount in TZS — whole numbers only
currencystringNoAlways TZS
destinationTypestringYesAlways mobile_money
destinationDetails.phoneNumberstringYes255XXXXXXXXX format
destinationDetails.networkstringYesMpesa, AirtelMoney, TigoPesa, or HaloPesa
destinationDetails.accountNamestringNoRecipient name shown on confirmation

Payout statuses

StatusMeaning
completedFunds delivered to recipient
processingSent to operator, awaiting confirmation
failedDelivery failed — funds returned to wallet
pending_reviewHeld for fraud review

List payouts

GET /api/v1/disbursements
x-api-key: sk_live_...

Save payout destinations

Store recurring recipient details as payout methods to avoid re-entering details each time:

POST /api/v1/merchant/payout-methods
x-api-key: sk_live_...
{
"destinationType": "mobile_money",
"destinationDetails": {
"phoneNumber": "255742000331",
"network": "Mpesa",
"accountName": "Jane Doe"
}
}