USSD Developer Gateway (English)

Integrate your external server with the CashPay USSD infrastructure using unique codes and real-time routing.

Introduction

The USSD Gateway allows any developer or business to expose their services via a mobile menu. We act as a high-performance router: when a user dials your assigned code (e.g., *2704*01#), we proxy that request to your server and return your response to the user's phone.

Unique Sub-Codes

Every project receives its own unique code in the *2704*XX# space.

Remote Logic

Keep your code on your own server. We only need your endpoint URL.

Quota System

Get 100 free sessions on start. Refills cost $2.00 per 100 sessions.

The Routing Protocol

Our gateway interacts with your application using standard HTTP GET requests. You must respond with plain text using the following prefixes:

CON
Continue: Use this to display a menu or message and keep the session active for user input.
HTML
```
CON Welcome to Global Bank\n1. My Balance\n2. Transfer Funds
```
END
End: Use this to display a final message and terminate the session.
HTML
```
END Your transaction was successful. Goodbye!
```

Request Parameters

On every user interaction, our router appends these query parameters to your endpoint URL:

Parameter	Description
sessionId	A unique ID for the current interaction chain. Remains the same until END.
phoneNumber	The mobile number of the user in international format (MSISDN).
serviceCode	The code composition (e.g., 270401#).
text	User inputs concatenated with . Example: "", "1", "12".

Routing Example

If a user dials your code and then enters '1', your server will receive:
GET https://your-server.com/ussd?sessionId=abc&phoneNumber=243...&text=1

Pricing & Quotas

Every project starts with 100 free test sessions. Once consumed, you can buy additional packs directly from your dashboard using your Fleet Account balance.

Standard Refill

$2.00 / 100 Sessions