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.
Note
For featureTags you will need to send x-api-version: 1 in headers.
Feature Tags Description
Scroll inside to view more
|
Feature Supported Value
|
Type
|
Feature Name
|
|---|---|---|
01
| SUPPORTED
| Mandate
|
05
| NOT_SUPPORTED
| Credit
|
06
| NOT_SUPPORTED
| PPI Wallet
|
09
| NOT_SUPPORTED
| UOD
|
10
| NOT_SUPPORTED
| Voucher
|
11
| SUPPORTED
| Special commercials 1 for RuPay Credit Card on UPI
|
12
| SUPPORTED
| Special commercials 2 for PPI on UPI
|
13
| SUPPORTED
| Special commercials 3 for Credit Line on UPI
|
31 to 56
| NOT_SUPPORTED
| Credit Line Products
|
14 to 30
| -
| Reserved for future use-cases
|
3 columns 11 rows
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{uri}/merchants/vpas/validity360
Headers
Content-Type
*
string
Required
application/json
x-merchant-signature
*
string
Required
This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.
x-merchant-id
*
string
Required
Will be shared while onboarding.
x-merchant-channel-id
*
string
Required
Will be shared while onboarding.
Accept
*
string
Required
application/json
x-timestamp
*
string
Required
This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.
x-api-version
Numeric String
Optional
This will return the featureTags field in the response when x-api-version = 1 is passed in the headers.
Parameters
vpa
*
String
Mandatory
VPA to be verified. In case of a upi mapper call, we need to pass the vpa as something@mapper.npci
Constraints: something@handle
upiRequestId
*
String
Mandatory
Unique id sent to UPI switch for the request
Constraints: 35 character alphanumeric. Should always start with merchant prefix provided.
udfParameters
JSON String
optional
Stringified JSON for udf parameters
200 : Success
Response Body
status
*
String
Mandatory
PSP status of the API
SUCCESS, FAILURE
responseCode
*
String
Mandatory
PSP response code for the API
Refer error code section
responseMessage
*
String
Mandatory
PSP response message for the API
Refer error code section
payload
*
Json
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 gatewaySUCCESS, 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
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
*
Boolean String
Mandatory
Flag indicating whether the VPA is of merchant or not
isMerchantVerified
Boolean String
optional
Flag indicating whether merchant is verified or not
isMandateSupported
Boolean String
optional
Flag indicating whether underlying bank linked to the vpa supports mandate feature or not.
mcc
String
optional
Merchant Category Code for the merchant whose VPA is passed
merchantType
Json
Optional
Merchant Type for the merchant whose VPA is passed
Identifier
*
Json
Mandatory
subCode
String
mid
String
sid
String
tid
String
merchantType
String
merchantGenre
String
onBoardingType
String
Name
*
json
Mandatory
brand
String
legal
String
franchise
String
Ownership
*
Json
Mandatory
type
String
featureTags
Array of String
Optional
This will be an array of feature values, each having it's own significance as decided by NPCI
udfParameters
JSON String
optional
Udf parameters as passed in the request