Trigger a mobile (USSD) collection
curl --request POST \
--url https://{gatewayHost}/api/collection/mobile \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 1000,
"currency": "TZS",
"payerPhone": "+255700000000",
"fspId": "CLICKPESA",
"transactionId": "ORDER_12345"
}
'import requests
url = "https://{gatewayHost}/api/collection/mobile"
payload = {
"amount": 1000,
"currency": "TZS",
"payerPhone": "+255700000000",
"fspId": "CLICKPESA",
"transactionId": "ORDER_12345"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 1000,
currency: 'TZS',
payerPhone: '+255700000000',
fspId: 'CLICKPESA',
transactionId: 'ORDER_12345'
})
};
fetch('https://{gatewayHost}/api/collection/mobile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{gatewayHost}/api/collection/mobile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 1000,
'currency' => 'TZS',
'payerPhone' => '+255700000000',
'fspId' => 'CLICKPESA',
'transactionId' => 'ORDER_12345'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{gatewayHost}/api/collection/mobile"
payload := strings.NewReader("{\n \"amount\": 1000,\n \"currency\": \"TZS\",\n \"payerPhone\": \"+255700000000\",\n \"fspId\": \"CLICKPESA\",\n \"transactionId\": \"ORDER_12345\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{gatewayHost}/api/collection/mobile")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1000,\n \"currency\": \"TZS\",\n \"payerPhone\": \"+255700000000\",\n \"fspId\": \"CLICKPESA\",\n \"transactionId\": \"ORDER_12345\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{gatewayHost}/api/collection/mobile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 1000,\n \"currency\": \"TZS\",\n \"payerPhone\": \"+255700000000\",\n \"fspId\": \"CLICKPESA\",\n \"transactionId\": \"ORDER_12345\"\n}"
response = http.request(request)
puts response.read_body{
"id": "LCPCATJHWWYQBY",
"orderReference": "MMPFDM3YGNYPLM",
"gatewayResponse": {
"status": "PROCESSING",
"channel": "AIRTEL-MONEY",
"orderReference": "MMPFDM3YGNYPLM",
"collectedAmount": "1000.00",
"collectedCurrency": "TZS"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Token expired or invalid"
}
}Collections
Trigger a mobile (USSD) collection
Initiates a USSD push to the payer’s phone. Uses the Collections gateway server + its own Bearer token. transactionId is your own unique reference (used to poll status and as an idempotency key).
POST
/
collection
/
mobile
Trigger a mobile (USSD) collection
curl --request POST \
--url https://{gatewayHost}/api/collection/mobile \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 1000,
"currency": "TZS",
"payerPhone": "+255700000000",
"fspId": "CLICKPESA",
"transactionId": "ORDER_12345"
}
'import requests
url = "https://{gatewayHost}/api/collection/mobile"
payload = {
"amount": 1000,
"currency": "TZS",
"payerPhone": "+255700000000",
"fspId": "CLICKPESA",
"transactionId": "ORDER_12345"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 1000,
currency: 'TZS',
payerPhone: '+255700000000',
fspId: 'CLICKPESA',
transactionId: 'ORDER_12345'
})
};
fetch('https://{gatewayHost}/api/collection/mobile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{gatewayHost}/api/collection/mobile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 1000,
'currency' => 'TZS',
'payerPhone' => '+255700000000',
'fspId' => 'CLICKPESA',
'transactionId' => 'ORDER_12345'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{gatewayHost}/api/collection/mobile"
payload := strings.NewReader("{\n \"amount\": 1000,\n \"currency\": \"TZS\",\n \"payerPhone\": \"+255700000000\",\n \"fspId\": \"CLICKPESA\",\n \"transactionId\": \"ORDER_12345\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{gatewayHost}/api/collection/mobile")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1000,\n \"currency\": \"TZS\",\n \"payerPhone\": \"+255700000000\",\n \"fspId\": \"CLICKPESA\",\n \"transactionId\": \"ORDER_12345\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{gatewayHost}/api/collection/mobile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 1000,\n \"currency\": \"TZS\",\n \"payerPhone\": \"+255700000000\",\n \"fspId\": \"CLICKPESA\",\n \"transactionId\": \"ORDER_12345\"\n}"
response = http.request(request)
puts response.read_body{
"id": "LCPCATJHWWYQBY",
"orderReference": "MMPFDM3YGNYPLM",
"gatewayResponse": {
"status": "PROCESSING",
"channel": "AIRTEL-MONEY",
"orderReference": "MMPFDM3YGNYPLM",
"collectedAmount": "1000.00",
"collectedCurrency": "TZS"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Token expired or invalid"
}
}Authorizations
Bearer token from POST /generate-token. Expires ~1h; on 401, re-generate and retry once.
Body
application/json
Collection amount. Minimum 1,000.
Example:
"TZS"
Payer phone in international (E.164) format.
Example:
"+255700000000"
Currently CLICKPESA (covers Airtel Money, Mixx by Yas, Halotel). More FSPs coming soon; bank collections on request.
Example:
"CLICKPESA"
Your unique reference; used to poll status and as the idempotency key.
Response
Collection initiated (a USSD prompt is sent to the payer)