UPI Address Validate API
This api is used to validate UPI VPA address.
Environment
| Environment | Http Method | API |
|---|---|---|
Sandbox | POST | https://api-preprod.phonepe.com/apis/pg-sandbox/v2/validate/upi |
Production | POST | https://api.phonepe.com/apis/pg/v2/validate/upi |
Request
Request Headers
| Header Name | Header Value |
|---|---|
Content-Type | application/json |
Authorization | O-Bearer <merchant-auth-token> |
Request Parameters
| Parameter Name | Data Type | Description | Mandatory (Yes/No) | Constraints |
type | String | Type of UPI Payment Address | Yes | Values allowed = [VPA] |
vpa | String | VPA of user to validate | Yes | Max Length = 255 |
Request Payload
{
"type": "VPA",
"vpa": "abc@ybl"
}Response
Response Headers
Header Name
Header Value
Content-Type
application/jsonSample Response for Case 1: VPA is Valid
{
"valid": true,
"name": "<Name of User>"
}Sample Response for Case 2: Invalid VPA
{
"valid": false
}Response Field
| Field Name | Data Type | Description |
|---|---|---|
valid | Boolean | • true → UPI address is valid. • false → UPI address is not valid. |
name | String | Name of the user. |