Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26294473.4 KB
Payouts
Create

Initiate a mobile money payout by sending a request to the API. The specified amount will be transferred to the recipient's mobile wallet.

post/payouts/create-mobile-money-payout

Request body

amountnumber required

Your payout amount

phoneNumberstring required

Mobile phone number to receive mobile money payout, starting with country code and without the plus sign, e.g., 255712345678

currency'TZS' | 'USD' required

Account currency to pay out from (TZS or USD). User will receive funds in TZS (Mobile can't hold USD)

orderReferencestring required

Your unique Order reference

checksumstring

If enabled, this is the generated checksum of the payload. Refer to the documentation for more details.

Response

Mobile money payout Preview response

updatedAtstring date-time
createdAtstring date-time
idstring
orderReferencestring

Your unique order reference

amountstring

Total amount deducted from your account balance (includes fee)

currencystring
feestring

Transaction fee deducted from source currency (included in amount)

exchangedboolean

Indicates if currency conversion was applied (true when source currency differs from receiving currency)

status'AUTHORIZED' | 'SUCCESS' | 'REVERSED'
channel'MOBILE MONEY'
channelProviderstring
clientIdstring

Application Client ID associated with the payout

Example response

{
  "amount": "1047.10",
  "currency": "TZS",
  "fee": "47.10",
  "exchanged": true,
  "exchange": {
    "sourceCurrency": "USD",
    "targetCurrency": "TZS",
    "sourceAmount": 1000,
    "rate": 2500
  },
  "channelProvider": "MPESA TANZANIA",
  "order": {
    "amount": "1000.00",
    "currency": "TZS"
  },
  "beneficiary": {
    "accountNumber": "255650000000",
    "accountName": "John Doe"
  }
}