Verify UPI Handle (VPA)

Request Parameters

Parameters	Type	Mandatory (M) , Optional(O)	Description
payee	Array	M	Payee details
payee.accountNumber	String	M	UPI id of the payee
bankIfsc	String	O	Bank Ifsc Code
externalRef	String	M	Unique Reference number
consent	String	M	Y - Yes N - No
pennyDrop	String	M	YES
latitude	String	M	Current location latitude
longitude	String	M	Current location longitude

Sample Request

curl --location --request POST 'https://api.instantpay.in/identity/verifyBankAccount' \
--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 '{
    "payee" : {
        "name" : "Instantpay India"
        "accountNumber" : "ipay.109564@icici",
        "bankIfsc" : ""
    },
    "externalRef" : "PPT223",
    "consent" : "Y",
    "isCached": "0",
    "latitude" : "21.3436",
    "longitude" : "70.8738"
}'

POST /identity/verifyBankAccount 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

{
    "payee" : {
        "name" : "Instantpay India"
        "accountNumber" : "ipay.109564@icici",
        "bankIfsc" : ""
    },
    "externalRef" : "PPT223",
    "consent" : "Y",
    "isCached": "0",
    "latitude" : "21.3436",
    "longitude" : "70.8738"
}

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": "Transaction Successful",
    "data": {
        "externalRef": "1732171930",
        "poolReferenceId": "1241121122210WSZUX",
        "txnValue": "0.00",
        "txnReferenceId": "00",
        "pool": {
            "account": "9876543210",
            "openingBal": "11.99",
            "mode": "DR",
            "amount": "0.00",
            "closingBal": "11.99"
        },
        "payer": {
            "account": "9876543210",
            "name": "SHAHBAZ STORE"
        },
        "payee": {
            "name": "Instantpay India Ltd",
            "account": "ipay.109564@icici",
            "ifsc": "ICIC0000104",
            "type": "",
            "mccCode": "0000",
            "merchantOnboardingType": "",
            "merchantGenre": "",
            "accountType": "SAVINGS",
            "iin": "",
            "nameMatchPercent": 96
        },
        "isCached": false,
        "isPennyDrop": false
    },
    "timestamp": "2024-11-21 12:22:11",
    "ipay_uuid": "h0009d8a4542-a4ca-4ba3-913c-a435a27ae0cc-QrdVY5UL0ll4",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}