Telecom Circle

Header Parameters

NameTypeDescriptionMandatory (M) , Optional (O)Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-CodeStringAuth Code - 1 (Fixed)MY
X-Ipay-Client-IdStringUnique Client IDMY
X-Ipay-Client-SecretStringUnique secret keyMY
X-Ipay-Outlet-IdStringMerchant unique IDMY
X-Ipay-Endpoint-IpStringEnd Customer IP AddressMN

Request Parameters

NameTypeDescription
typeStringMandatoryIt will be Either MSISDN or OPERATOR
msisdnStringOptional
( Mandatory If type is MSISDN)
First 5 digit of Mobile Number
billerIdStringOptional
( Mandatory If type is Operator)
Biller Id of the Operator

Sample Request

curl --location --request POST 'https://api.instantpay.in/marketplace/utilityPayments/circle' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzNlM2ExEcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 679db35f926b8d0240a8c0d2fa0b20c04454004d2d825' \
--header 'X-Ipay-Endpoint-Ip: 45.115.105.205' \
--header 'X-Ipay-Outlet-Id: 72762' \
--data-raw '{
 "type" : "MSISDN",
 "msisdn" :"941234",
 "billerId" : ""
}
'
POST /marketplace/utilityPayments/circle HTTP/1.1
Host: api.instantpay.in
Accept: application/json
Content-Type: application/json
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzYzNlEcETrD5Yx+Q=
X-Ipay-Client-Secret: 679db35f926b8d0240a8c0d28fa0b20c04454004d2d825
X-Ipay-Endpoint-Ip: 45.115.105.205
X-Ipay-Outlet-Id: 72762
Content-Length: 62

{
 "type" : "MSISDN",
 "msisdn" :"941234",
 "billerId" : ""
}

Response Parameters

NameTypeDescription
statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus Message
dataArrayResponse Data (If Present)
timestampStringCurrent time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )
environmentStringLive

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Data Fetched Successfully",
    "data": [
        {
            "circleCode": "AS",
            "circle": "ASSAM"
        },
        {
            "circleCode": "BR",
            "circle": "BIHAR & JHARKHAND"
        },
        {
            "circleCode": "KO",
            "circle": "KOLKATA"
        },
        {
            "circleCode": "OR",
            "circle": "ODISHA"
        },
        {
            "circleCode": "NE",
            "circle": "NORTH EAST"
        },
        {
            "circleCode": "WB",
            "circle": "WEST BENGAL"
        },
        {
            "circleCode": "MH",
            "circle": "MAHARASHTRA & GOA"
        },
        {
            "circleCode": "MP",
            "circle": "MP & CHHATTISGARH"
        },
        {
            "circleCode": "MU",
            "circle": "MUMBAI"
        },
        {
            "circleCode": "GJ",
            "circle": "GUJARAT"
        },
        {
            "circleCode": "PB",
            "circle": "PUNJAB"
        },
        {
            "circleCode": "RJ",
            "circle": "RAJASTHAN"
        },
        {
            "circleCode": "UE",
            "circle": "UP (EAST)"
        },
        {
            "circleCode": "UW",
            "circle": "UP (WEST) & UTTARAKHAND"
        },
        {
            "circleCode": "HR",
            "circle": "HARYANA"
        },
        {
            "circleCode": "HP",
            "circle": "HIMACHAL PRADESH"
        },
        {
            "circleCode": "JK",
            "circle": "JAMMU & KASHMIR"
        },
        {
            "circleCode": "DL",
            "circle": "DELHI - NCR"
        },
        {
            "circleCode": "AP",
            "circle": "AP & TELANGANA"
        },
        {
            "circleCode": "CH",
            "circle": "CHENNAI"
        },
        {
            "circleCode": "KL",
            "circle": "KERALA"
        },
        {
            "circleCode": "KA",
            "circle": "KARNATAKA"
        },
        {
            "circleCode": "TN",
            "circle": "TAMIL NADU"
        },
        {
            "circleCode": "-1",
            "circle": "ALL INDIA"
        }
    ],
    "timestamp": "2023-07-05 16:23:10",
    "ipay_uuid": "h0689992b877-2327-47fc-a270-3dd9834b9d18",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}

❗️

Please Note:

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

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