Validate VPA Address

768 views Last Updated On: 11 Nov 2024

This API is used for verifying the correctness and authenticity of a Virtual Payment Address (VPA) within a digital payment system(UPI).

Post:

https://{{staging/production}}/upi/requestupivalidateaddress

Request Post Parameters:

PARAMETER
Data TypeDescription
vpaAddress
StringUnique identifier assigned to users
vpaHolderName
String
Only alphabets, single quote ( ' ) and dot ( . ) allowed
Latitude
String
Device Latitude
Longitude
String
Device Longitude
Location
String
Device Location
IPAddress
String
Device IP Address
DeviceSerial
String
Device Serial
DeviceOS
String
Device operating System Type
AppTechName
String
Name of the Application


Body:

{
	"vpaAddress":"902938****@digikhata",
    "vpaHolderName":"Manishkumar Patel",
    "Latitude":"19.181970",
    "Longitude":"72.872060",
    "Location":"400097",
    "IPAddress":"10.0.77.13",
    "DeviceSerial":"Chrome",
    "DeviceOS":"Windows",
    "AppTechName":"com.digikhata.in"
}


Response Parameters:

PARAMETER NAME

DATA TYPE

DESCRIPTION
resultCode
StringStatus of Transaction whether transaction pending, success or failed.
resultStatus
String

resultMessage
String
Status Message for the transaction. In case if the “resultStatus” of the request is “fail” then it will contain the reason for “Failure”.
data
Parameter Name
Data Type
Description
vpaHolderName
String
If the request is successful it will have VPA Holder Name.
MCC
String
if the request is successful it will have MCC Code for Merchant VPA addresses and for Person it will have "0000".
EntityType
String
If the request is successful. if the VPA Address belongs to Merchant it will have value "ENTITY", For Person it will have value "PERSON".





Response:

{
    "resultCode": "000",
    "resultStatus": "success",
    "resultMessage": "Success",
    "data": {
        "vpaHolderName": "Kapilaben Kantilal Patel",
        "MCC": "0000",
        "EntityType": "PERSON"
    }
}

Result Code
Result CodeResult StatusResult Message
401
FailAccess Denied
RNFFailNo merchant virtual id found.
000Success"Success", data = new { vpaHolderName = "", MCC = "", EntityType = "" }
500FailSorry, your request is not processed please try after some time. Log_Id -