UPI Address Validate API

This api is used to validate UPI VPA address.

anchor image
Copied !

Host URL

EnvironmentHttp MethodHeader Value
SandboxPOSThttps://api-preprod.phonepe.com/apis/pg-sandbox
ProductionPOSThttps://api.phonepe.com/apis/pg

API Endpoint

/v2/validate/upi

anchor image
Copied !

Request Headers

Header NameHeader Value
Content-Typeapplication/json
AuthorizationO-Bearer <access_token>

Request Parameters

Parameter NameData TypeDescriptionMandatory (Yes/No)Constraints
typeSTRINGType of UPI Payment AddressYesValues allowed = [VPA]
vpaSTRINGVPA of user to validateYesMax Length = 255

Request Payload

{ "type": "VPA", "vpa": "abc@ybl" }

Response from the API : 

Response Headers:

Header NameHeader Value
Content-Typeapplication/json

Response Payload:

Case 1: VPA is Valid

{ "valid": true, "name": "<Name of User>" }

Case 2: Invalid VPA

{ "valid": false }

Response Field Details:

Field NameData TypeDescription
validBooleantrue → UPI address is valid.
false → UPI address is not valid.
nameStringName of the user.