PIN Code Lookup

PIN Code verification service, returns data points around a PIN Code.

Header Parameters

NameTypeDescriptionMandatory (M) , Optional (O)Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-CodeStringAuth Code is "1" (Fixed)MY
X-Ipay-Client-IdStringUnique Client ID Provided by InstantpayMY
X-Ipay-Client-SecretStringUnique Client Secret Provided by InstantpayMY
X-Ipay-Endpoint-IpStringEnd customer IP AddressMY

Request Parameters

Parameter NameTypeRequirementDescription
pincodeStringMandatoryPin Code
latitudeStringMandatoryEnd Customer Latitude
longitudeStringMandatoryEnd Customer Longitude
externalRefStringMandatoryUnique Transaction id

Sample Request

curl --location '' \
--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 '{
    "pincode": "",
    "latitude": "27.897394",
    "longitude": "78.088013",
    "externalRef": "233"
POST /identity/pincode/lookup HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 679db35f926b8d0240a8c0d28729528ee8e6d5effa5fa0b20c04454004d2d825
Content-Length: 118

    "pincode": "",
    "latitude": "27.897394",
    "longitude": "78.088013",
    "externalRef": "233"

Response Parameters

Parameter NameTypeDescription
statuscodeStringInstantpay Status Code
actcodeStringAction Code
statusArrayStatus message
dataStringResponse Data(if Present)
timestampStringResponse time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id (if transaction; otherwise, it is null)
    "statuscode": "TXN",
    "actcode": null,
    "status": "Transaction Successful",
    "data": {
        "poolReferenceId": "1230918180511SJUVR",
        "pool": {
            "account": "7428585742",
            "openingBal": "6.93",
            "mode": "DR",
            "amount": "0.12",
            "closingBal": "6.81"
        "pincodeDetails": {
            "pincode": "110025",
            "city": "",
            "district": "SOUTH DELHI",
            "stateName": "DELHI",
            "stateCode": "DL",
            "gstStateCode": "07",
            "stateZone": "N",
            "geoLat": "28.5621470000",
            "geoLong": "77.4532100000"
    "timestamp": "2023-09-18 18:05:11",
    "ipay_uuid": "h0689a29bcc1-26e3-4989-8308-d5e3398ee686-ipPleKMgk49d",
    "orderid": "1230918180511SJUVR",
    "environment": "LIVE",
    "internalCode": null
Click Try It! to start a request and see the response here!