UPI - VPA

UPI VPA verification service which returns the name of the bank account holder by inputting VPA. Works for all IMPS & UPI enabled banks.

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

M

externalRef

String

M

Unique Reference number

consent

String

M

Y - Yes
N - No

isCached

String

M

0

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" : {
        "accountNumber" : "i**y.*****@icici",
        "bankIfsc" : "0"
    },
    "externalRef" : "PPT223",
    "consent" : "Y",
    "isCached": "0",
    "latitude" : "20.5936",
    "longitude" : "78.9628"
}'
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" : {
        "accountNumber" : "i**y.*****@icici",
        "bankIfsc" : "0"
    },
    "externalRef" : "PPT223",
    "consent" : "Y",
    "isCached": "0",
    "latitude" : "2*.***6",
    "longitude" : "7*.***8"
}

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": "PPT223",
        "poolReferenceId": "12204**********ARF",
        "txnValue": "0.00",
        "txnReferenceId": "21********92",
        "pool": {
            "account": "97******31",
            "openingBal": "13.46",
            "mode": "DR",
            "amount": "1.18",
            "closingBal": "12.28"
        },
        "payer": {
            "account": "97******31",
            "name": "A**N AG*****S"
        },
        "payee": {
            "account": "i**y.*****@icici",
            "name": "S****T ****E"
        },
        "isCached": false
    },
    "timestamp": "2022-04-27 16:46:56",
    "ipay_uuid": "h0689629b1cb-d5a9-4d54-92bf-e27e4ac55d7c",
    "orderid": "12**************RF",
    "environment": "LIVE",
}
Language
Click Try It! to start a request and see the response here!