Quickstart

# 1. Generate a token (counts toward the pre-KYC daily API cap)
curl -X POST https://api.clickpesa.com/third-parties/generate-token \
  -H "client-id: YOUR_CLIENT_ID" \
  -H "api-key: YOUR_API_KEY"

# 2. Preview a small USSD Push (reuse TOKEN for up to 1 hour)
# The generate-token response already prefixes token with "Bearer "
curl -X POST https://api.clickpesa.com/third-parties/payments/preview-ussd-push-request \
  -H "Authorization: TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": "1000",
    "currency": "TZS",
    "orderReference": "TEST001",
    "phoneNumber": "255712345678"
  }'

const BASE_URL = "https://api.clickpesa.com/third-parties";

async function generateToken(clientId, apiKey) {
  const res = await fetch(`${BASE_URL}/generate-token`, {
    method: "POST",
    headers: {
      "client-id": clientId,
      "api-key": apiKey,
    },
  });
  return res.json(); // { success, token } — token already includes "Bearer "
}

async function previewUssdPush(token, payload) {
  const res = await fetch(`${BASE_URL}/payments/preview-ussd-push-request`, {
    method: "POST",
    headers: {
      Authorization: token,
      "Content-Type": "application/json",
    },
    body: JSON.stringify(payload),
  });
  return res.json();
}

const { token } = await generateToken("YOUR_CLIENT_ID", "YOUR_API_KEY");

const preview = await previewUssdPush(token, {
  amount: "1000",
  currency: "TZS",
  orderReference: "TEST001", // alphanumeric, max 20 characters
  phoneNumber: "255712345678",
});

console.log(preview);

import requests

BASE_URL = "https://api.clickpesa.com/third-parties"

def generate_token(client_id, api_key):
    response = requests.post(
        f"{BASE_URL}/generate-token",
        headers={"client-id": client_id, "api-key": api_key},
    )
    response.raise_for_status()
    return response.json()  # { "success", "token" } — token already includes "Bearer "

def preview_ussd_push(token, payload):
    response = requests.post(
        f"{BASE_URL}/payments/preview-ussd-push-request",
        headers={"Authorization": token, "Content-Type": "application/json"},
        json=payload,
    )
    response.raise_for_status()
    return response.json()

token = generate_token("YOUR_CLIENT_ID", "YOUR_API_KEY")["token"]

preview = preview_ussd_push(
    token,
    {
        "amount": "1000",
        "currency": "TZS",
        "orderReference": "TEST001",  # alphanumeric, max 20 characters
        "phoneNumber": "255712345678",
    },
)

print(preview)

<?php
$baseUrl = "https://api.clickpesa.com/third-parties";

$ch = curl_init("$baseUrl/generate-token");
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_HTTPHEADER => [
    "client-id: YOUR_CLIENT_ID",
    "api-key: YOUR_API_KEY",
  ],
]);
$tokenResponse = json_decode(curl_exec($ch), true);
curl_close($ch);

$token = $tokenResponse["token"]; // already includes "Bearer "

$payload = json_encode([
  "amount" => "1000",
  "currency" => "TZS",
  "orderReference" => "TEST001", // alphanumeric, max 20 characters
  "phoneNumber" => "255712345678",
]);

$ch = curl_init("$baseUrl/payments/preview-ussd-push-request");
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_HTTPHEADER => [
    "Authorization: $token",
    "Content-Type: application/json",
  ],
  CURLOPT_POSTFIELDS => $payload,
]);
$preview = curl_exec($ch);
curl_close($ch);

echo $preview;