REST-style API
JSON over HTTPS for catalogue lookup, order placement and status retrieval, authenticated with per-partner credentials issued through a secure channel.
Developers
JubilePay provides a documented API for platforms and integrators, alongside managed tools for partners who prefer not to integrate. Documentation, test environment and credentials are issued to qualified partners under agreement. The example below is illustrative only.
How access works
| API documentation | Shared with partners under agreement |
|---|---|
| Test environment | Provided during technical onboarding |
| Production access | Issued through a secure channel after go-live checks |
| Managed (non-API) access | See Managed distribution |
Documentation
API documentation is shared with qualified partners under agreement. Register your interest and our team will walk you through it.
Integration options
Webhooks
Status notifications pushed to a URL you register, so your system does not have to poll.
Managed tools
For partners who do not want to integrate: ordering through managed tools under the Business distribution product.
Design principles
- Idempotent order requests so retries never duplicate a delivery.
- Explicit, documented status values for every order.
- A test environment that behaves like production, with clearly marked test data.
- Credentials never sent by email; rotation supported from day one.
- Versioned API with a published deprecation policy.
Illustrative shape of an order request
Illustrative only — not a live endpointThe example below shows the kind of request and response being designed. It is illustrative only: the host, paths, fields and values are not real and will change. Do not build against it.
POST /v0/orders (illustrative)
Host: api.example.invalid
Authorization: Bearer <partner-token>
Idempotency-Key: 7f1c…
Content-Type: application/json
{
"product_id": "example-airtime-product",
"recipient": { "msisdn": "+000000000000" },
"amount": { "value": "5.00", "currency": "XXX" },
"reference": "your-order-ref-123"
}HTTP/1.1 202 Accepted (illustrative)
Content-Type: application/json
{
"order_id": "ord_example",
"status": "processing",
"reference": "your-order-ref-123"
}POST https://partner.example.invalid/webhooks/jubilepay (illustrative)
Content-Type: application/json
X-Signature: sha256=…
{
"event": "order.completed",
"order_id": "ord_example",
"status": "completed",
"reference": "your-order-ref-123",
"occurred_at": "2026-01-01T00:00:00Z"
}Request API access
Tell us about your platform, the products you want to offer and your markets. Select “API or technical integration” on the contact form.