Build services for the
Digital USSD network
Connect your application to USSDPad using standard HTTP requests, REST APIs, and per-code webhooks. Your application controls the customer experience. USSDPad manages code resolution, session routing, application rendering, reseller attribution, and order visibility.
Integration Guide
Follow the complete integration process—from obtaining your API key and configuring a webhook to returning customer screens and initiating payment through your own gateway.
API Reference
Review available endpoints, authentication requirements, request fields, response formats, session behavior, reseller operations, and order management.
How the integration works
Register your business, access the Platform Portal, and request a main service code.
Open API Settings in the Platform Portal and securely copy your platform API key. Use it as a Bearer token for authenticated endpoints.
Assign an HTTPS webhook endpoint to your main code. Sub-codes inherit the main webhook automatically unless you configure a separate override.
Create resellers from the Platform Portal or API. Each reseller receives a unique sub-code based on your main code and the selected suffix.
When a customer enters your code, USSDPad sends the session details to your webhook. Return the next screen, accepted input type, and session step.
Create payment through your own gateway and return your reference, amount, and checkout URL. USSDPad opens it; customer funds go directly to your gateway account.
After your payment provider confirms the transaction, update the corresponding USSDPad order to successful. Only confirm an order after independently verifying the callback from your payment provider.
Important: Never expose your API key in mobile applications, browser code, public repositories, or customer-facing systems.
What you can build
Use the same session and webhook architecture for:
Integration requirements
Before going live, your application should:
- Accept HTTPS POST requests containing JSON
- Verify the USSDPad HMAC signature before processing a session
- Return valid JSON with an HTTP 2xx response
- Respond within the documented timeout
- Keep API keys and gateway credentials on the server
- Treat session and customer information as sensitive
- Generate unique order references
- Handle duplicate requests safely
- Verify payment-provider callbacks
- Update order status only after payment confirmation
Developer support
Need help understanding a session request, payment flow, reseller route, or API response?
Contact technical support