POST
/
payout-link
/
generate-payout-url
cURL
curl --request POST \
  --url https://api.clickpesa.com/third-parties/payout-link/generate-payout-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "<string>",
  "orderReference": "<string>",
  "checksum": "<string>"
}'
{
  "payoutLink": "<string>",
  "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
​
amount
string

Your payout amount

​
orderReference
string

Your unique Order reference

​
checksum
string

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

Response

Generate Payout URL Response

​
payoutLink
string

Hosted Payout Link

​
clientId
string

Application Client ID associated with the payoutLink