Authentication Overview
Client ID - Remains accessible in your application settings and is also required for API authentication.
API Key - It is required for API authentication, displayed only once during creation. Copy and store it securely
JWT Token - API Key
and Client ID
are exchanged for a short-lived JWT Token
, which is then used in all subsequent API calls.
The JWT token is valid for 1hr (60 Minutes) from the time of issuance. After it expires, you must generate a new token using your API Key
and Client ID
.
Never share your API credentials or JWT token publicly. Always use HTTPS to protect your credentials during transmission.
Application Setup
Step 1: Log in to the ClickPesa Dashboard
Go to the ClickPesa Dashboard and log in with your credentials.
Step 2: Access Developer Settings
- In the dashboard, click Settings.
- Navigate to the Developers section.
Step 3: Create a New Application
Click Create Application to begin the setup process.
When creating your application, provide the following details:
- Application Name: A name to identify your app.
- Integration Type: Select API.
- Features: Choose the required features (e.g. Payment API, Payout API).
Step 5: Submit Your Application
Click Create to finalize the application setup.
Managing API Keys
Important: Keep your API credentials secure and do not share them publicly.
Access API Keys
- Navigate to Settings in the ClickPesa dashboard.
- Go to the Developers section.
- Select the application for which you want to manage API keys.
- Click Manage API Keys in the application settings.
- A panel will appear, showing the list of existing API keys, including:
- Name: Assigned name of the API key.
- Last Activity: Date of last use.
- Revoke Button: Option to deactivate the key.
Adding a New API Key
- Navigate to Settings in the ClickPesa dashboard.
- Go to the Developers section.
- Select the application for which you want to create an API key.
- Click Manage API Keys in the application settings.
- Click Add API Key.
- A modal will appear where you can enter the required details:
- Name: A label for the API key.
- Expiry Date: Define when the key will expire.
- Click Submit to proceed.
- The modal will prompt you to enter your password for confirmation.
- After successfully confirming your password, the API key will be created.
- The modal will then display:
- The Client ID and newly generated API Key.
- The Expiry Date.
Responses are generated using AI and may contain mistakes.