How do I get started with the API services?

Our API services let your own software do mobile and DTH recharges, pay utility bills and verify documents such as PAN and bank accounts. You send one request per transaction and get the result back as JSON. This article takes you from zero to your first test call.

1. Request access

  1. Sign in to the client area. Your email address must be confirmed.
  2. Open My services › API services.
  3. Fill in Request API access: your company name, your website if you have one, and a sentence or two about what you plan to build, for example "a recharge app for retailers" or "KYC of new customers on our platform".
  4. Accept the API terms and press Request access.

Test keys work as soon as the form is sent. Live access is given after our team has reviewed the request. If identity verification is required for your account, completing it speeds up the review; the page tells you when it is needed.

2. Create a test key

  1. Open API services › API keys (the keys page).
  2. Under Create a key, give the key a name such as "Development laptop".
  3. Choose Test (sandbox, free) and, if you like, an expiry.
  4. Press Create key.

The page shows the API key and the signing secret once. Copy both now and store them on your server; they are never shown again. If you lose them, revoke the key and create a new one.

3. Make your first call

Your endpoint is shown on the overview page under Your endpoint. Every request carries your key in the X-Api-Key header. The public API documentation on our website lists each service with its fields and has ready examples in PHP, Node.js and Python that you can copy.

A request names the service, the values it needs (for a recharge: number, operator and amount) and your own reference for the transaction, called client_ref. The answer contains the status, our reference and a message.

4. Try everything in the sandbox

Test keys never touch your wallet and never move real money. The sandbox answers with predictable results, so you can program for every case: success, failure and pending. The documentation lists the test values that produce each result.

If the Test console is shown in the menu of the API pages, you can send test calls from the browser without writing code and see the exact request and answer. It is the quickest way to understand a service.

5. Handle the three outcomes

  • Success: the transaction is done.
  • Failed: nothing was delivered. For a live call, the amount is returned to your wallet automatically.
  • Pending: the operator has not confirmed yet. Do not treat this as a failure and do not send the transaction again. The final status arrives through your webhook, and you can also ask for it with the status call.

Programming these three cases correctly is the most important part of the integration.

6. Go live

After approval:

  1. Choose a package under the packages page. A package says which services it includes; its price is added to your wallet as credit.
  2. Whitelist your server's IP address under Security and webhooks. Live keys work only from whitelisted addresses.
  3. Add funds to the API wallet.
  4. Create a live key and put it on your server in place of the test key.

Make one small real transaction first and check it under Transactions before you open the service to your users.

Where to see what happened

The overview page shows your wallet balance, the live calls of today, what you spent this month and the last transactions. Transactions lists every call with its status, amount, charge and both references, and can be filtered by status and date.

Prices

Each service has its price or commission. Open See all services and prices on the overview page for your rates, including the rates per operator. Prices can differ by package.

Getting help

Open a ticket under Support › Support tickets and include our transaction reference or your client_ref, the time of the call and the answer you received. Never send your signing secret; we do not need it.

Was this article helpful?

Still stuck? Open a support ticket and our team will help.


Related articles

← Back

Chat with us
Hi! Send us a message and we will reply here as soon as we can.
Security check image
Chat with us