JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Verify VPA 2.0

The Virtual Payment Address or VPA is a unique ID given to an individual using the Unified Payment Interface (UPI) service to send or receive money. In the case of UPI collect VPA is the mandatory param and merchants are always advised to check if the VPA is valid or not.
Validating the VPA will help in reducing the failure rate due to incorrect vpa.

Currently, we have verify VPA API support for the below-acquiring partners.

AXIS
CASHFREE
HDFC
HSBC
ICICI
INDUS
KOTAK
PAYU
PAYTM
RAZORPAY
YESBANK

Either the customer id or the order id is mandatory for clientAuthToken based verify VPA request.
The response payload also contains mandate_detailsblock where mandate eligibility of the VPA is shown.

Request

Response

API Endpoints

Sandbox Link

POST

https://sandbox.juspay.in/v2/upi/verify-vpa

Production Link

POST

https://api.juspay.in/v2/upi/verify-vpa

                      Content-Type
                      
                      

string

application/x-www-form-urlencoded

                      Authorization
                      
                      

string

Base 64 encoded value of the API key

Body

                      vpa
                      *
                      

String

Mandatory

The VPA for which the eligibility has to be checked

                      merchant_id
                      *
                      

String

Mandatory

The merchant id that the merchant holds with Juspay

                      client_auth_token	
                      
                      

String

The authentication token required for client side calls. Required if you are calling the API from Client Side

                      customer_id
                      
                      

String

The unique id associated with the customer. Required for clientAuthToken based request

                      order_id
                      
                      

String

Unique Identifier for the order. Required for clientAuthToken based request

Response Body

vpa

string

The VPA sent in the request

                      status
                      
                      

string

The expected value is "VALID" for a valid VPA and "INVALID" for incorrect VPA

                      mandate_details
                      
                      

object

Details specific to mandate support

                      is_handle_supported
                      
                      

boolean

                      customer_name
                      
                      

string

The name of the customer provided during VPA registration. The default value for a valid VPA will be "verified".

Response Body

                      status
                      
                      

string

Invalid Request

                      error_code
                      
                      

string

invalid_request_error

                      error_message
                      
                      

string

VPA can't be empty or null