If you run a recharge portal, app or retailer panel, the first thing a customer does is type a mobile number. What happens next decides whether the recharge succeeds: you must know the operator, the circle and the plans that are valid right now. This guide shows the shortest reliable path from zero to a working integration.
1. Get your credentials
Create an account, complete e-KYC on your dashboard and activate a subscription plan. You will use the same username and pwd on every call. Open the API & IP Whitelist page to copy them and, if you want, restrict the API to your server's IP address (see our IP whitelisting guide).
2. Resolve the operator and circle
Never ask the customer to pick an operator. Call Operator & Circle Fetch with the 10-digit number:
GET /planapi/operatorCircleFetch?username=YOUR_ID&pwd=YOUR_PWD&mobileno=9876543210A successful response contains "ERROR": "0" plus the OpCode (for example A for Airtel) and the CircleCode. Numbers move between operators, so always look the number up instead of caching it for months.
3. Fetch the plans
GET /planapi/planFetch?username=YOUR_ID&pwd=YOUR_PWD&operatorcode=A&circle=49The RDATA object groups plans into categories such as recommended packs, data packs and top-ups. Render the categories as tabs and show rs, validity and desc for each pack.
4. Handle errors like a professional
- Treat anything other than
"ERROR": "0"as a failure and show a friendly retry message. - Read the
Messagefield: it tells you about authentication, IP, e-KYC or daily-limit problems. - Set a client timeout of about 15 seconds and retry once, never in a tight loop.
5. Go live checklist
- Cache plan lists for a few hours (see caching and daily limits).
- Log the
Messageof failed calls so support can trace issues quickly. - Poll
usageStatusonce at start-up to display remaining daily hits.
Ready to try it? Read the full API documentation or talk to us if you want help planning your volume.
Frequently asked questions
How long does the integration take?
Most teams make their first successful Plan Fetch call within an hour. A production-ready integration with error handling, caching and monitoring usually fits in a working day.
Do I need a different key for each endpoint?
No. One username and password works on every endpoint. Your plan decides how many hits you get per day across all of them.
Ready to build?
Create an account, pick a plan and make your first call today. Every plan includes every endpoint.
Create account Read the docs
