Documentation

Build with Ureh

One API for airtime, data, cable TV, electricity and education payments, with wallets, transactions and webhooks built in. From your first API key to a production integration.

Overview

You integrate once, against one contract. Every product takes the same request shape over plain HTTP with a JSON body, and returns the same response envelope whether it succeeded, is still processing, or failed.

Five concepts carry across every product:

• Products. Airtime, data, cable TV, electricity and education are each their own endpoint under /api/v1, documented in full in the API Reference.
• Wallet. Every purchase debits your wallet automatically. Ureh sets the price, so you are never charged an amount your own request supplied.
• Earnings. Every eligible purchase earns you commission 2% to ₦150 per transaction, depending on the product applied automatically. See Developer Earnings.
• Transactions. Every purchase returns a reference immediately, then settles to success or failed.
• Webhooks. Subscribe once and be notified the moment a transaction settles, instead of polling for it.

Documentation shortcuts

• Authentication Bearer-token credentials and the two key types the API enforces server side.
• API Keys Issue, rotate and revoke the Secret and Public keys behind every request.
• API Reference Every endpoint, field and error code for all five bill payment products.
• Webhooks Signed, retried delivery the moment a transaction reaches a final state.
• Guides Practical walkthroughs for idempotency, webhooks and failure handling.
• Errors The full error envelope and every code your integration should handle.
• Rate Limits How requests are limited per IP, key, client and endpoint.

SDKs

No client libraries are available yet. Every integration today calls the API directly over HTTP and JSON. The API Reference carries the request and response body for every endpoint, and the same call in cURL, PHP and Node.js shows it wired up in each language.

• Node.js Planned Planned support for modern JavaScript and TypeScript backends.
• PHP Planned Planned support for PHP applications, including Laravel.
• Python Planned Planned support for Python services and data pipelines.
• Go Planned Planned support for high-throughput Go services.
• Flutter Planned Planned support for Flutter mobile applications.