Body
Verify VPA 360
This API will be used to resolve the name of the entity to whom a vpa belongs. In case of a valid vpa, it will provide the name and other details of the entity.
name, ifsc and iin will be sent in response only when gatewayResponseCode is "00".
isMerchantVerified, mcc and merchantType will be sent in response only when isMerchant is "true".
UPI Numbers can also be resolved using this API by passing the request parameter vpa in the format upiNumber@mapper.npci (Example: 9876543210@mapper.npci). The actual VPA mapped to the upiNumber shall be sent in the response parameter vpa.
Request
Response
API Endpoints
Production Link
POST
{{host}}/api/{{uri}}/merchants/vpas/validity360
Headers
jpupi-routing-id
*
String
Mandatory
Header value should be same as of upiRequestId sent in request body
Request Schema: application/json
Parameters
vpa
*
String
Mandatory
VPA to be verified.
Example: something@handle.
Constraint: VPA should only contain a-z, 0-9, . (dot), - (hyphen).
iat
*
String
Mandatory
Current Epoch Unix timestamp string. Has to be of 13 digit in Milliseconds.
Example: 1496918882000.
upiRequestId
*
String
Mandatory
Unique id sent for the request.
Constraints: Must be 35 character alphanumeric. Should always start with PSP Prefix.
udfParameters
Stringified JSON
Optional
Merchant Defined Parameters
Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"
Note: Few special characters are not allowed. Regex for the characters which are not allowed : ^[^/#-()*!%~`]+$
200 : Success
Response Body
status
*
String
Mandatory
PSP status of the API.
Values: SUCCESS, FAILURE.
responseCode
*
String
Mandatory
PSP response code for the API.
Values: Refer Codes Guide in Resource Section.
responseMessage
*
String
Mandatory
PSP response message for the API.
Values: Refer Codes Guide in Resource Section.
payload
*
Json String
Mandatory
merchantId
*
String
Mandatory
Unique id for the merchant as passed in request headers.
merchantChannelId
*
String
Mandatory
Unique id for the merchant channel as passed in request headers.
gatewayTransactionId
*
String
Mandatory
Transaction id returned by gateway.
gatewayResponseStatus
*
String
Mandatory
Response status returned by gateway.
SUCCESS, FAILURE
gatewayResponseCode
*
String
Mandatory
Response code returned by gateway.
gatewayResponseMessage
*
String
Mandatory
Response message for code returned by gateway.
vpa
*
String
Mandatory
This is a vpa for which name should be resolved.
Values:As passed in request.
name
String
Optional
Name of the customer.
ifsc
String
Optional
IFSC code of the account linked to this VPA.
iin
String
Optional
IIN code of the account linked to this VPA.
isMerchant
*
String
Mandatory
Flag indicating whether the VPA is of merchant or not.
isMerchantVerified
String
Optional
Flag indicating whether merchant is verified or not.
mcc
String
Optional
Merchant Category Code for the merchant whose VPA is passed.
merchantType
String
Optional
Merchant Type for the merchant whose VPA is passed.
upiNumber
String
optional
Number mapped to a customer's VPA that is unique to the customer across the UPI ecosystem.
Values:8 to 10 digit numeric string. 10 digit number must be the mobile number. Last 3 digits must not be same. Must not start with a 0.
accType
String
optional
Account Type.
udfParameters
Stringified JSON
optional
Merchant Defined Parameters
Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"
Have questions?
- Need help? Contact support
- LLM? Read llms.txt