POST
/
payouts
/
create-mobile-money-payout
cURL
curl --request POST \
  --url https://api.clickpesa.com/third-parties/payouts/create-mobile-money-payout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 123,
  "phoneNumber": "<string>",
  "currency": "TZS",
  "exchange": {
    "fromCurrency": "USD",
    "toCurrency": "USD",
    "rate": 123,
    "amount": 123
  },
  "orderReference": "<string>",
  "checksum": "<string>"
}'
{
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "orderReference": "<string>",
  "amount": "1047.10",
  "currency": "TZS",
  "fee": "47.10",
  "exchanged": true,
  "exchange": {
    "sourceCurrency": "USD",
    "targetCurrency": "TZS",
    "sourceAmount": 1000,
    "rate": 2500
  },
  "status": "AUTHORIZED",
  "channel": "MOBILE MONEY",
  "channelProvider": "MPESA TANZANIA",
  "order": {
    "amount": "1000.00",
    "currency": "TZS"
  },
  "beneficiary": {
    "accountNumber": "255650000000",
    "accountName": "John Doe",
    "amount": "1000.00"
  },
  "clientId": "<string>"
}

Authorizations

Authorization
string
header
required

Authorization header containing the JWT access token returned from the generate token endpoint. The token already includes the Bearer prefix. Example: Authorization: Bearer eyJhbGciOi...

Body

application/json

Response

Mobile money payout Preview response

The response is of type object.