get http://api.instantpay.in/marketplace/utilityPayments/telecomCircles
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 |
Sample Request
curl --location 'http://api.instantpay.in/marketplace/utilityPayments/telecomCircles' \
--header 'Accept: application/json' \
--header 'Content-Type: 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 'X-Ipay-Outlet-Id: {{outletID}}' \
--data ''
curl --location 'http://api.instantpay.in/marketplace/utilityPayments/telecomCircles' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 82e4755d7c1cf636816addfe1460936d7b64612208df87f3000aa5b56fc926d1' \
--header 'X-Ipay-Endpoint-Ip: 45.115.105.205' \
--header 'X-Ipay-Outlet-Id: 12345' \
--data ''
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": "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.