Validate VPA

This API validates a customer's Virtual Payment Address (VPA), also known as a UPI ID, and returns the associated account holder's name. It is an optional step before creating a UPI AutoPay mandate.

API Details

Parameter	Value
Method	POST
Endpoint	/mandate-validate-vpa
Base URL	{{BASE_URL}}
Content-Type	application/json

Authentication

Include the following credentials in the JSON request body. These credentials are available in the WowPe Dashboard.

Parameter	Location	Type	Mandatory	Description
clientId	Request Body	String	Yes	Merchant Client ID provided in the WowPe Dashboard.
secretKey	Request Body	String	Yes	Merchant Secret Key provided in the WowPe Dashboard.

Request Header

Header	Value
Content-Type	application/json

Request Parameters

The following parameter is required in addition to the authentication credentials.

Parameter	Type	Mandatory	Description
vpa	String	Yes	Customer's UPI ID. Example: customer@okhdfcbank.

Sample Request

JSON

{
  "clientId": "YOUR_CLIENT_ID",
  "secretKey": "YOUR_SECRET_KEY",
  "vpa": "customer@okhdfcbank"
}

cURL Request

Bash

curl --request POST '{{BASE_URL}}/mandate-validate-vpa' \
  --header 'Content-Type: application/json' \
  --data '{
    "clientId": "YOUR_CLIENT_ID",
    "secretKey": "YOUR_SECRET_KEY",
    "vpa": "customer@okhdfcbank"
  }'

Replace {{BASE_URL}} with the applicable WowPe API environment URL and use your merchant credentials.

Sample Response

Success Response

JSON

{
  "statusCode": 1,
  "message": "Success",
  "vpa": "customer@okhdfcbank",
  "name": "RAHUL KUMAR"
}

Response Parameters

Parameter	Type	Description
statusCode	Number	Indicates the API operation status. 0 = Failed, 1 = Succeeded, 2 = Pending.
message	String	Provides the response message for the API operation.
vpa	String	Customer's validated UPI ID.
name	String	Account holder's name returned by the API.

Error Handling

Status Code	Description	Action
0	API operation failed.	Check the response message and review the request parameters.
2	API operation is pending.	Check the relevant operation status before proceeding.

If a request times out or its outcome is unknown, verify the existing operation before submitting another request.

Important Notes

• VPA validation is an optional step before mandate creation.
• The name field contains the account holder's name returned by the API.
• Successful VPA validation does not mean that a UPI AutoPay mandate has been created or approved.
• The mandate-create request does not include a vpa parameter. Do not add the validated VPA to that request based on this API.

What's Next

Once the VPA validation is complete, proceed to the Create Mandate API to create a UPI AutoPay mandate and generate the customer approval link.