UPI Verification

UPI is the most popular way for customers & merchants to accept and transfer money. Verify UPI ID in real-time using Sandbox API for error-free money transfer.

Overview

Verify a UPI ID by passing the virtual_payment_address and receive the name of the account holder along with the UPI verification status.

Problem

  • UPI is widely used as a payment method in the Indian Payment Eco-system, making it critical to verify UPI IDs before making a payment.
  • However, Businesses do not have a way to verify UPI IDs.

Solution

  • API to verify UPI ID and provide validation details like account existence and name at the bank.

Endpoint

HTTP MethodResource
GET/bank/upi/:virtual_payment_address

API Endpoint  Contact Us  Free Trial

Request

Follow the below guidelines to pass the UPI ID and name.

Path Parameters

ParamTypeDescriptionExample
virtual_payment_addressstringVPA of account to be validated (UPI ID). Alphanumeric, period (.), hyphen (-), at sign (@), and underscore (_) are allowed
(100 character limit).
jonedoe@okhdfcbank

📘

Please Note

Underscore (_) and dot (.) get accepted before and after at sign (@), but hyphen (-) get accepted only before the at sign (@).

Query Parameters

ParamTypeDescriptionExample
namestringName of the Account holder.John Doe

Sample CURL request

curl --location --request GET 'https://api.sandbox.co.in/bank/upi/jonedoe@okhdfcbank' \
--header 'Authorization: eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJBUEkiLCJyZWZyZXNoX3Rva2VuIjoiZXlKaGJHY2lPaUpJVXpVeE1pSjkuZXlKaGRXUWlPaUpCVUVraUxDSnpkV0lpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1Gd2FWOXJaWGtpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1semN5STZJbUZ3YVM1eGRXbGphMjh1WTI5dElpd2laWGh3SWpveE5Ua3dPVFk1TmpBd0xDSnBiblJsYm5RaU9pSlNSVVpTUlZOSVgxUlBTMFZPSWl3aWFXRjBJam94TlRVNU16UTNNakF3ZlEueHNmYkhQTERFRlRvTy1OUWdaUUpLM25OUjFxdlhvWmhaOHRqS3gzSExydjZiVkJaMHpJZEZ5ai1MUTg1YnJZS0xXQnFnZHlzZ1NDSXlDUXNtV2VOYkEiLCJzdWIiOiJqb2huQGRvZS5jb20iLCJhcGlfa2V5Ijoia2V5X2xpdmVfQWRlKioqKioqKioqKioqKioqKioqKioqKioqKipVeHMiLCJpc3MiOiJhcGkucXVpY2tvLmNvbSIsImV4cCI6MTU5MTA1NjAwMCwiaW50ZW50IjoiQUNDRVNTX1RPS0VOIiwiaWF0IjoxNTkwOTY5NjAwfQ.nH23CR5RHGQ0U19I_vq3vyJ_85A1a2iEMQij5QHgJQdDuS9x7FmTidsr1CQabSFF5ujE40SFxHv1gJM20TauUw' \
--header 'x-api-key: key_live_Ade**************************Uxs' \
--header 'x-api-version: 1.0.0'

❗️

Test Environment Not Available


Response

ParamTypeDescriptionExample
transaction_idstringReference id of the verification1234567
account_existsbooleanIndicates if the account exists or not. Possible values are true or falsetrue
name_at_bankstringName of the account holderJohn Doe

Response Caching

Response caching is not available for this API. Learn more about our response caching mechanism here

Wallet Charges

Since UPI Verification API is a Paid API, a wallet charge will take place.

Versioning

This API is currently in major version 1.0. Refer to our versioning policies here