POST
/
payouts
/
create-mobile-money-payout-request
curl --request POST \
  --url https://api.clickpesa.com/third-parties/payouts/create-mobile-money-payout-request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 123,
  "phoneNumber": "<string>",
  "currency": "TZS",
  "orderReference": "<string>",
  "checksum": "<string>"
}'
{
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "orderReference": "<string>",
  "amount": "1000",
  "currency": "TZS",
  "fee": "47.00",
  "status": "AUTHORIZED",
  "channel": "MOBILE MONEY",
  "channelProvider": "MPESA TANZANIA",
  "beneficiary": {
    "accountNumber": "255650000000",
    "accountName": "John Doe"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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
​
updatedAt
string
​
createdAt
string
​
id
string
​
orderReference
string

Your unique order reference

​
amount
string
Example:

"1000"

​
currency
string
Example:

"TZS"

​
fee
string
Example:

"47.00"

​
status
enum<string>
Available options:
AUTHORIZED,
SUCCESS,
REVERSED
​
channel
enum<string>
Available options:
MOBILE MONEY
​
channelProvider
string
Example:

"MPESA TANZANIA"

​
beneficiary
object