Header Parameters

Name	Type	Description	Mandatory (M) , Optional (O)	Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-Code	String	Auth Code is "1" (Fixed)	M	Y
X-Ipay-Client-Id	String	Unique Client Id Provided by Instantpay	M	Y
X-Ipay-Client-Secret	String	Unique Client Secret Provided by Instantpay	M	Y
X-Ipay-Endpoint-Ip	String	End customer IP Address	M	Y

Request Parameters

Parameter Name	Type	Requirement	Description
ip	String	Mandatory	IP Address
latitude	String	Mandatory	End Customer Latitude.
longitude	String	Mandatory	End Customer Longitude
externalRef	String	Mandatory	Unique Transaction id

Sample Request

curl --location 'https://api.instantpay.in/identity/ip/lookup' \
--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}}' \
--data '{
    "ip": "49.249.72.66",
    "latitude": "27.897394",
    "longitude": "78.088013",
    "externalRef": "233"
}'

POST /identity/ip/lookup HTTP/1.1
Host: api.instantpay.in
Accept: application/json
Content-Type: application/json
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 679db35f926b8d0240a8c0d28729528ee8e6d5effa5fa0b20c04454004d2d825
X-Ipay-Endpoint-Ip: 45.115.105.205
Content-Length: 118

{
    "ip": "49.249.72.66",
    "latitude": "27.897394",
    "longitude": "78.088013",
    "externalRef": "233"
}

Response Parameters

Parameter Name	Type	Description
statuscode	String	Instantpay Status Code
actcode	String	Action Code
status	Array	Status message
data	String	Response Data(if Present)
timestamp	String	Response 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/Sandbox

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Data Fetched Successful",
    "data": {
        "ipData": {
            "ip": "160.19.164.0",
            "type": "IPv4",
            "hostname": null,
            "carrier": {
                "name": null,
                "mcc": null,
                "mnc": null
            },
            "company": {
                "domain": null,
                "name": null,
                "type": "business"
            },
            "connection": {
                "asn": null,
                "domain": null,
                "organization": null,
                "route": null,
                "type": null
            },
            "currency": {
                "code": "USD",
                "name": "US Dollar",
                "nameNative": "US Dollar",
                "plural": "US dollars",
                "pluralNative": "US dollars",
                "symbol": "$",
                "symbolNative": "$",
                "format": {
                    "negative": {
                        "prefix": "-$",
                        "suffix": ""
                    },
                    "positive": {
                        "prefix": "$",
                        "suffix": ""
                    }
                }
            },
            "location": {
                "continent": {
                    "code": "NA",
                    "name": "North America"
                },
                "country": {
                    "area": 9629091,
                    "borders": [
                        "CA",
                        "MX"
                    ],
                    "callingCode": "1",
                    "capital": "Washington D.C.",
                    "code": "US",
                    "name": "United States",
                    "population": 333287557,
                    "populationDensity": 34.61,
                    "flag": {
                        "emoji": ":us:",
                        "emojiUnicode": "U+1F1FA U+1F1F8"
                    },
                    "languages": [
                        {
                            "code": "en",
                            "name": "English",
                            "native": "English"
                        },
                        {
                            "code": "es",
                            "name": "Spanish",
                            "native": "español"
                        },
                        {
                            "code": "fr",
                            "name": "French",
                            "native": "français"
                        }
                    ],
                    "tld": ".us"
                },
                "region": {
                    "code": "US-MO",
                    "name": "Missouri"
                },
                "city": "Schell City",
                "postal": "64780",
                "latitude": 38.03056,
                "longitude": -94.0897,
                "language": {
                    "code": "en",
                    "name": "English",
                    "native": "English"
                },
                "inEu": false
            },
            "security": {
                "isAbuser": false,
                "isAttacker": true,
                "isBogon": true,
                "isCloudProvider": false,
                "isProxy": false,
                "isRelay": false,
                "isTor": false,
                "isTorExit": false,
                "isVpn": false,
                "isAnonymous": false,
                "isThreat": true
            },
            "timeZone": {
                "id": "America/Chicago",
                "abbreviation": "CST",
                "currentTime": "2023-08-21T04:25:09-05:00",
                "name": "Central Standard Time",
                "offset": -18000,
                "inDaylightSaving": true
            }
        },
        "poolReferenceId": "1230821175848KCEUF",
        "pool": {
            "openingBal": "997499.76",
            "amount": "0.12",
            "closingBal": "997499.64"
        }
    },
    "timestamp": "2023-08-21 17:58:48",
    "ipay_uuid": "h00099f166e5-5630-48f6-8ebb-f93b89e2f71c-cKMctQaskOEt",
    "orderid": "1230821175848KCEUF",
    "environment": "SANDBOX",
    "internalCode": null
}