PayOrbit
Sign in

Plan & Operator · Operator & Plans

Mobile Plan Fetch

Fetch prepaid recharge plans for an operator and circle

POST request

URL: https://api.payorbit.in/api/v1/plan/operator-plan-fetch

Body

{
    "circle": "52",
    "mobile": "9431023126",
    "opcode": "J",
    "orderid": "PLN_001"
}

Include a valid Bearer token with every request

Code sample

curl -X POST "https://api.vizodigital.com/api/v1/plan/operator-plan-fetch" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "mobile": "9431023126",
    "opcode": "J",
    "circle": "52",
    "orderid": "PLN_001"
}'

Success Response

{
    "fee": 0,
    "data": {
        "plans": {
            "STV": [
                {
                    "rs": 49,
                    "Type": "stv",
                    "desc": "Sample unlimited calls STV (UAT)",
                    "validity": "28 Days"
                }
            ],
            "DATA": [
                {
                    "rs": 19,
                    "Type": "data",
                    "desc": "Sample 1GB data pack (UAT)",
                    "validity": "1 Day"
                },
                {
                    "rs": 299,
                    "Type": "data",
                    "desc": "Sample 2GB/day data pack (UAT)",
                    "validity": "28 Days"
                }
            ],
            "TOPUP": [
                {
                    "rs": 10,
                    "Type": "talktime",
                    "desc": "Sample talktime top-up (UAT)",
                    "validity": "NA"
                },
                {
                    "rs": 20,
                    "Type": "talktime",
                    "desc": "Sample talktime top-up (UAT)",
                    "validity": "NA"
                }
            ]
        },
        "orderid": "PLN_001",
        "operator": "Jio PREPAID"
    },
    "status": "success",
    "message": "UAT sample — prepaid plans. Use production credentials for live aggregator data.",
    "wallet_balance": 1000
}

Failure response

{
    "status": "error",
    "message": "Request failed. Check credentials, wallet balance, or validation errors."
}

Overview

Fetches available prepaid recharge plans (TOPUP, DATA, STV, etc.) for a mobile operator and circle.

Use operator find first to get company / circle_code, then map to the opcode and circle values below.

UAT returns sample TOPUP / DATA / STV packs (fee = 0, no aggregator hit). Production returns live plans and charges the configured fee.

Access & billing same as Operator Find (operator_plan_fetch service key).

Mobile opcodes

  • A — Airtel
  • V — Vodafone
  • J — Jio
  • BT — BSNL Topup
  • BS — BSNL Special

Circle codes

  • 105 — JHARKHAND
  • 104 — MIZZORAM
  • 103 — MEGHALAY
  • 102 — GOA
  • 101 — CHHATISGARH
  • 100 — TRIPURA
  • 99 — SIKKIM
  • 49 — AP
  • 95 — KERALA
  • 94 — TAMIL NADU
  • 40 — CHENNAI
  • 06 — KARNATAKA
  • 52 — BIHAR
  • 16 — NESA
  • 56 — ASSAM
  • 53 — ORISSA
  • 51 — West Bengal
  • 31 — KOLKATTA
  • 70 — RAJASTHAN
  • 93 — MP
  • 98 — GUJARAT
  • 90 — MAHARASHTRA
  • 92 — MUMBAI
  • 54 — UP(East)
  • 55 — J&K
  • 96 — HARYANA
  • 03 — HP
  • 02 — PUNJAB
  • 97 — UP(West)
  • 10 — DELHI

Body

application/json required

Mobile Plan Fetch request body

Schema

{
    "type": "object",
    "required": [
        "mobile",
        "opcode",
        "circle",
        "orderid"
    ],
    "properties": {
        "circle": {
            "type": "string",
            "description": "Circle code, e.g. 52 for Bihar"
        },
        "mobile": {
            "type": "string",
            "description": "10-digit mobile number"
        },
        "opcode": {
            "type": "string",
            "description": "Operator code, e.g. A, V, J, BT, BS"
        },
        "orderid": {
            "type": "string",
            "description": "Unique client order / request ID"
        }
    }
}

Example

{
    "circle": "52",
    "mobile": "9431023126",
    "opcode": "J",
    "orderid": "PLN_001"
}

Responses

  • 200 · application/json default

    Successful response

    Example

    {
        "fee": 0,
        "data": {
            "plans": {
                "STV": [
                    {
                        "rs": 49,
                        "Type": "stv",
                        "desc": "Sample unlimited calls STV (UAT)",
                        "validity": "28 Days"
                    }
                ],
                "DATA": [
                    {
                        "rs": 19,
                        "Type": "data",
                        "desc": "Sample 1GB data pack (UAT)",
                        "validity": "1 Day"
                    },
                    {
                        "rs": 299,
                        "Type": "data",
                        "desc": "Sample 2GB/day data pack (UAT)",
                        "validity": "28 Days"
                    }
                ],
                "TOPUP": [
                    {
                        "rs": 10,
                        "Type": "talktime",
                        "desc": "Sample talktime top-up (UAT)",
                        "validity": "NA"
                    },
                    {
                        "rs": 20,
                        "Type": "talktime",
                        "desc": "Sample talktime top-up (UAT)",
                        "validity": "NA"
                    }
                ]
            },
            "orderid": "PLN_001",
            "operator": "Jio PREPAID"
        },
        "status": "success",
        "message": "UAT sample — prepaid plans. Use production credentials for live aggregator data.",
        "wallet_balance": 1000
    }

Rate Limits

60/min