POST
/
payouts
/
preview-mobile-money-payout
curl --request POST \
  --url https://api.clickpesa.com/third-parties/payouts/preview-mobile-money-payout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 123,
  "phoneNumber": "<string>",
  "currency": "TZS",
  "orderReference": "<string>",
  "checksum": "<string>"
}'
{
  "amount": 1047.1,
  "balance": 2000,
  "channelProvider": "TIGO PESA",
  "fee": 47.1,
  "order": {
    "amount": 1000,
    "currency": "TZS",
    "id": "UNIQUEREFERENCE"
  },
  "payoutFeeBearer": "merchant",
  "receiver": {
    "accountName": "John Doe",
    "accountNumber": "255650000000"
  }
}

Authorizations

​
Authorization
string
header
required

Authorization header in the form of Bearer <token>, where <token> is a valid JWT from generate token endpoint

Body

application/json
​
amount
number
required
​
phoneNumber
string
required
​
currency
enum<string>
required
Available options:
TZS
​
orderReference
string
required

Your unique Order reference

​
checksum
string

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

Response

200
application/json
Mobile money payout Preview response
​
amount
number
Example:

1047.1

​
balance
number
Example:

2000

​
channelProvider
string
Example:

"TIGO PESA"

​
fee
number
Example:

47.1

​
order
object
​
payoutFeeBearer
enum<string>
Available options:
merchant,
both,
customer
Example:

"merchant"

​
receiver
object