Skip to main content

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.

  • Quick & Flexible – Generate Hosted Checkout links with minimal API calls and seamlessly integrate them across platforms.
  • Secure & User-Friendly – Designed for a secured seamless experience for developers and users.

​
Prerequisites

  1. Hosted Application - Create an application and generate Client ID and API Keys for Hosted Checkout
  2. Authorization Token - Use API Keys of to Generate Authorization Token

​
How It Works

Generate Hosted Checkout Link

Use this API endpoint to generate a Hosted Checkout Link

​
Payment notifications

When a customer completes payment on the hosted checkout page (including mobile push payments), you can receive status updates in three ways:
  1. Application webhooks — Configure PAYMENT RECEIVED (and PAYMENT FAILED if needed) under your hosted application in the dashboard.
  2. callbackUrl on the generate link request — Optional field on Generate Checkout Link. ClickPesa sends an HTTP POST to this URL when a payment for that link succeeds.
  3. Query Payment API — Poll by your orderReference.
If an application webhook is configured for the event, it is used instead of the merchant-level webhook. See Webhooks for payload details.
After payment, customers are redirected to the Return URL on your hosted application in the dashboard. That redirect is not set on the generate link request.