Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26294473.4 KB
Payouts
Preview

Validates mobile money payout details like phone number, amount, order-reference, fee

post/payouts/preview-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

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

amountnumber

Total amount to be deducted from your account balance (includes fee)

balancenumber
channelProviderstring
feenumber

Transaction fee deducted from source currency (included in amount)

exchangedboolean

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

payoutFeeBearer'merchant' | 'both' | 'customer'

Example response

{
  "amount": 1047.1,
  "balance": 2000,
  "channelProvider": "TIGO PESA",
  "fee": 47.1,
  "exchanged": true,
  "exchange": {
    "sourceCurrency": "USD",
    "targetCurrency": "TZS",
    "sourceAmount": 1000,
    "rate": 2500
  },
  "order": {
    "amount": 1000,
    "currency": "TZS",
    "id": "UNIQUEREFERENCE"
  },
  "payoutFeeBearer": "merchant",
  "receiver": {
    "accountName": "John Doe",
    "accountNumber": "255650000000",
    "accountCurrency": "TZS",
    "amount": 1000
  }
}