Plans

Header Parameters

Name

Type

Description

Mandatory (M) , Optional (O)

Provided by INSTANTPAY (Y/N)

X-Ipay-Auth-Code

String

Auth Code - 1 (Fixed)

M

Y

X-Ipay-Client-Id

String

Unique Client ID

M

Y

X-Ipay-Client-Secret

String

Unique secret key

M

Y

X-Ipay-Outlet-Id

String

Merchant unique ID

M

Y

X-Ipay-Endpoint-Ip

String

End Customer IP Address

M

N

Request Parameters

Name

Type

Description

billerId

String

Biller Id of the Operator

circleCode

String

Circle Code

Sample Request

curl --location --request GET 'https://api.instantpay.in/marketplace/utilityPayments/plans' \
--header 'Accept: application/json' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--header 'Content-Type: application/json' \
--data-raw '{
        "billerId":"ATP",
    "circleCode":"MU"
}'
GET /marketplace/utilityPayments/plans HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
Content-Type: application/json
Accept: application/json

{
    "billerId":"ATP",
    "circleCode":"MU"
}

Response Parameters

Name

Type

Description

statuscode

String

InstantPay Status Code

actcode

String

Action Code

status

String

Status Message

data

Array

Response Data (If Present)

timestamp

String

Current time (YYYY-MM-DD HH:II:SS)

ipay_uuid

String

Request reference number

orderid

String

Transaction Id ( If transaction otherwise it is null )

environment

String

Live

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Plans fetched successfully",
    "data": [
        {
            "id": 3250986,
            "billerId": "ATP",
            "circleCode": "MU",
            "rechargeValue": "8998",
            "rechargeTalktime": "Details: Unlimited incoming 3600 mins India calls 100 sms.| Covered Countries : Australia Canada Chi",
            "rechargeValidity": "180 Days",
            "rechargeShortDescription": "International Roaming",
            "rechargeDescription": "Details: Unlimited incoming 3600 mins India calls 100 sms.| Covered Countries : Australia Canada China Friance Japan Singapore USA UK & more. Visit www.airtel.in/IR"
        },
        {
            "id": 3250987,
            "billerId": "ATP",
            "circleCode": "MU",
            "rechargeValue": "128",
            "rechargeTalktime": "Enjoy Local & STD calls 2.5p/sec National Video Calls 5p/sec DATA 50p/MB; SMS Rs.1 Local Rs.1.5 STD ",
            "rechargeValidity": "28 Days",
            "rechargeShortDescription": "ISD Pack",
            "rechargeDescription": "Enjoy Local & STD calls 2.5p/sec National Video Calls 5p/sec DATA 50p/MB; SMS Rs.1 Local Rs.1.5 STD Rs.5 ISD"
        },
        {
            "id": 3250988,
            "billerId": "ATP",
            "circleCode": "MU",
            "rechargeValue": "399",
            "rechargeTalktime": "Enjoy unlimited Local STD & Roaming calls on any network 2.5GB/day data and 100 SMS.",
            "rechargeValidity": "28 Days",
            "rechargeShortDescription": "Unlimited Packs",
            "rechargeDescription": "Enjoy unlimited Local STD & Roaming calls on any network 2.5GB/day data and 100 SMS."
        },
        {
            "id": 3250989,
            "billerId": "ATP",
            "circleCode": "MU",
            "rechargeValue": "14997",
            "rechargeTalktime": "Details: Unlimited incoming 7200 mins India calls 100 sms.| Covered Countries : Bangladesh Bhutan My",
            "rechargeValidity": "365 Days",
            "rechargeShortDescription": "International Roaming",
            "rechargeDescription": "Details: Unlimited incoming 7200 mins India calls 100 sms.| Covered Countries : Bangladesh Bhutan Myanmar Nepal Sri Lanka. Visit www.airtel.in/IR"
        },
        {
            "id": 3250990,
            "billerId": "ATP",
            "circleCode": "MU",
            "rechargeValue": "6999",
            "rechargeTalktime": "Details: 500mins incoming 5GB 500mins local/India calls 100 sms. | Covered Countries : Maldives Nige",
            "rechargeValidity": "30 Days",
            "rechargeShortDescription": "International Roaming",
            "rechargeDescription": "Details: 500mins incoming 5GB 500mins local/India calls 100 sms. | Covered Countries : Maldives Nigeria South Africa Kenya Uganda Zambia & more countries. Visit www.airtel.in/ir"
        },
        {
            "id": 3250991,
            "billerId": "ATP",
            "circleCode": "MU",
            "rechargeValue": "549",
            "rechargeTalktime": "Enjoy unlimited Local STD & Roaming calls on any network daily 2GB data and 100 SMS.",
            "rechargeValidity": "56 Days",
            "rechargeShortDescription": "Unlimited Packs",
            "rechargeDescription": "Enjoy unlimited Local STD & Roaming calls on any network daily 2GB data and 100 SMS."
        },
        {
            "id": 3250992,
            "billerId": "ATP",
            "circleCode": "MU",
            "rechargeValue": "1799",
            "rechargeTalktime": "Enjoy Unlimited Local STD & Roaming calls Local STD & Roaming calls on any network 24GB Data and 360",
            "rechargeValidity": "365 Days",
            "rechargeShortDescription": "Unlimited Packs",
            "rechargeDescription": "Enjoy Unlimited Local STD & Roaming calls Local STD & Roaming calls on any network 24GB Data and 3600 SMS. Pack valid for 365 days."
        },
        {
            "id": 3250993,
            "billerId": "ATP",
            "circleCode": "MU",
            "rechargeValue": "839",
            "rechargeTalktime": "Enjoy unlimited Local STD & Roaming calls on any network 2GB/day data and 100 SMS.",
            "rechargeValidity": "84 Days",
            "rechargeShortDescription": "Unlimited Packs",
            "rechargeDescription": "Enjoy unlimited Local STD & Roaming calls on any network 2GB/day data and 100 SMS."
        },
        {
            "id": 3250994,
            "billerId": "ATP",
            "circleCode": "MU",
            "rechargeValue": "58",
            "rechargeTalktime": "Enjoy 3GB data valid till your current pack validity",
            "rechargeValidity": "NA",
            "rechargeShortDescription": "Data",
            "rechargeDescription": "Enjoy 3GB data valid till your current pack validity"
        },
    ],
    "timestamp": "2022-09-14 14:19:50",
    "ipay_uuid": "h00697431f05-*****************1-a631b22e6eb3",
    "orderid": null,
    "environment": "LIVE",
}

❗️

Please Note :

Call this API once a Week to sync the data in your application.

Language
Click Try It! to start a request and see the response here!