Verify VPA

This API is used to check if the given VPA is valid or not.

Request Headers

Header NameHeader Value
Content-Typeapplication/json
X-VERIFYSHA256("/v3/vpa/{merchantId}/{vpa}/validate" +
saltKey) + "###" + saltIndex

Path Parameters

Parameter NameTypeDescriptionMandatory
merchantIdSTRINGUnique Merchant ID assigned to the merchant by PhonePeYes
vpaSTRINGVPA (UPI ID) for which validation is requiredYes

Response Parameters

Parameter NameTypeDescription
successBOOLEANA boolean to indicate the success/failure of the request. Merchant should check for this parameter if VPA exists or not
codeENUM(see list of codes below)This parameter is used to decide if collect was successfully sent or not.
messageSTRINGShort message about status of VPA
existsBOOLEANFlag indicates if VPA (UPI ID) exists
nameSTRINGName of the person registered on this VPA
vpaSTRINGVPA ID passed in request

Response Codes

CodeDescription
EXTERNAL_VPA_ERRORIncorrect VPA. VPA ID does not exists.
BAD_REQUESTSome mandatory parameter was missing
AUTHORIZATION_FAILEDChecksum sent in header was not valid
INTERNAL_SERVER_ERRORSomething went wrong

🚧

  1. To check if a VPA is valid, Merchant should consider the following values.
    The value of data would be populated only if value of success is true.

success:true
code:SUCCESS
exists:true

  1. IFSC bank codes for which a central IFSC is received instead of the actual IFSC code and need to be blocked are subjected to change and some of the banks might start sending the actual IFSC or there could be a new set of banks sharing the centralized IFSC in future.

Please note that PhonePe will only be passing the data to Merchant. PhonePe will not be doing any validation or filtration of the IFSC from its end

Merchants are expected to add validations on IFSC and CBS names from its end to filter out the list for the payouts.

CNRB - Canara Bank
RATN - Ratnakar Bank
APGV - Andhra Pradesh Grameena Vikas Bank
MAHG - Maharashtra Gramin Bank
ESFB - Equitas Small Finance Bank
UMSB - The Udaipur Mahila Samridhi Urban Co-operative Bank Ltd.
UUCB - The Udaipur Urban Co-Operative Bank Ltd.
FINO -Fino Payments Bank
NSPB - NSDL Payments Bank
DBSS - DBS Bank
CLBL - Capital Bank
JIOP - Jio Payments Bank
FSFB - Fincare Small Finance Bank
DEUT - Deutsche Bank
IPOS - India Post Payments Bank

Language
Click Try It! to start a request and see the response here!