Skip to main content
POST
/
checkout-link
/
generate-checkout-url
cURL
curl --request POST \
  --url https://api.clickpesa.com/third-parties/checkout-link/generate-checkout-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "totalPrice": "<string>",
  "orderReference": "<string>",
  "customerName": "<string>",
  "customerEmail": "<string>",
  "customerPhone": "<string>",
  "description": "<string>",
  "callbackUrl": "<string>",
  "wooCommerceCallbackURL": "<string>",
  "checksum": "<string>"
}
'
{
  "checkoutLink": "<string>",
  "clientId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.clickpesa.com/llms.txt

Use this file to discover all available pages before exploring further.

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
​
totalPrice
string
required

Your order amount

​
orderReference
string
required

Your unique Order reference

​
orderCurrency
enum<string>
required

Your order payment currency to receive in(e.g., TZS, USD)

Available options:
TZS,
USD
​
customerName
string

Your customer name

​
customerEmail
string

Your customer email

​
customerPhone
string

Your customer phone number, starting with country code and without the plus sign, e.g., 255712345678

​
description
string

Your order description

​
callbackUrl
string

Optional URL that receives an HTTP POST when a payment for this checkout link succeeds. Separate from application webhooks configured in the dashboard.

​
wooCommerceCallbackURL
string

Optional WooCommerce order callback URL for this checkout link.

​
checksum
string

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

Response

Generate Checkout Link Response

​
checkoutLink
string

Hosted Checkout Link

​
clientId
string

Application Client ID associated with the checkoutLink