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

Request:

Field

Type

Description

Mandatory/Optional

vpa

String

The VPA for which the eligibility has to be checked

Mandatory

merchant_id

String

The merchant id that the merchant holds with Juspay

Mandatory

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

📘

Note

Either the customer id or the order id is mandatory for clientAuthToken based verify VPA request.

Response:

Field

Type

Description

vpa

String

The VPA sent in the request

status

String

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

customer_name

String

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

mandate_details

Json

Details specific to mandate support

mandate_details JSON block:

is_handle_supported

Boolean

VPA handle supported or not.

The merchant may rely on the param "status" to check if the VPA is valid or not.

Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!