Circle

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

type

String

It will be Either MSISDN or OPERATOR

msisdn

String

First 5 digit of Mobile Number

billerId

String

Biller Id of the Operator

Sample Request

curl --location --request POST 'https://api.instantpay.in/marketplace/utilityPayments/circle' \
--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 '{
 "type" : "MSISDN",
 "msisdn" :"9****4",
 "billerId" : "BGC"
}'
POST /marketplace/utilityPayments/circle 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

{
 "type" : "MSISDN",
 "msisdn" :"9****4",
 "billerId" : "BGC"
}

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": "Circle fetched successfully",
    "data": [
        {
            "circleCode": "AP",
            "circle": "AP & TELANGANA"
        },
        {
            "circleCode": "AS",
            "circle": "ASSAM"
        },
        {
            "circleCode": "BR",
            "circle": "BIHAR & JHARKHAND"
        },
        {
            "circleCode": "CH",
            "circle": "CHENNAI"
        },
        {
            "circleCode": "DL",
            "circle": "DELHI - NCR"
        },
        {
            "circleCode": "GJ",
            "circle": "GUJARAT"
        },
        {
            "circleCode": "HR",
            "circle": "HARYANA"
        },
        {
            "circleCode": "HP",
            "circle": "HIMACHAL PRADESH"
        },
        {
            "circleCode": "JK",
            "circle": "JAMMU & KASHMIR"
        },
        {
            "circleCode": "KL",
            "circle": "KERALA"
        },
        {
            "circleCode": "KO",
            "circle": "KOLKATA"
        },
        {
            "circleCode": "MH",
            "circle": "MAHARASHTRA & GOA"
        },
        {
            "circleCode": "MP",
            "circle": "MP & CHHATTISGARH"
        },
        {
            "circleCode": "MU",
            "circle": "MUMBAI"
        },
        {
            "circleCode": "NE",
            "circle": "NORTH EAST"
        },
        {
            "circleCode": "OR",
            "circle": "ODISHA"
        },
        {
            "circleCode": "PB",
            "circle": "PUNJAB"
        },
        {
            "circleCode": "RJ",
            "circle": "RAJASTHAN"
        },
        {
            "circleCode": "TN",
            "circle": "TAMIL NADU"
        },
        {
            "circleCode": "UE",
            "circle": "UP (EAST)"
        },
        {
            "circleCode": "UW",
            "circle": "UP (WEST) & UTTARAKHAND"
        },
        {
            "circleCode": "WB",
            "circle": "WEST BENGAL"
        }
    ],
    "timestamp": "2022-09-14 14:19:50",
    "ipay_uuid": "h006******************************-a631b22e6eb3",
    "orderid": null,
    "environment": "LIVE",
}

❗️

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!