Introduction

API Reference Guide

API Changelog

Understand Razorpay APIs

Authentication

Sandbox Setup

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Subscriptions

Route

Smart Collect

TPAP Pro

Customer Onboarding

Accounts Management

Payments

Mandates

Complaints

UPI Number

UPI Lite

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Fetch Balance

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

Payments

Tpap Pro

Upi Number

Resolve

API Test Keys

Resolve UPI Number

POST
/v1/upi/tpap/upi_number/resolve

Click to copy

Use this endpoint to resolve a UPI number into VPA, name, IFSC, and business information.

Is this page helpful?

Curl

1
-X POST 'https://api.rzp.<bank>.com/v1/upi/tpap/upi_number/resolve' \
2
-u [YOUR_KEY_ID]:[YOUR_SECRET] \
3
-H "Content-Type: application/json" \
4
-H "x-device-fingerprint: <device_fingerprint>" \
5
-H "x-device-fingerprint-timestamp: 1496918882000" \
6
-H "x-customer-reference: cust_ref" \
7
-d '{
8
  "upi_number": "9898989898",
9
  "device": {
10
    "geocode": "12.34,77.13",
11
    "ip": "198.1.1.1"
12
  }
13
}'

Response

Failure

1
{
2
  "entity": "upi_number",
3
  "number": "9898989898",
4
  "upi_transaction_id": "TXNxmms",
5
  "vpa": "gaurav.kumar@rzpa",
6
  "fundsource": {
7
    "customer_name": "kunal1",
8
    "ifsc": "SBI00001",
9
    "upi_iin": ""
10
  },
11
  "is_merchant_vpa": true,
12
  "is_merchant_verified": true,
13
  "mcc": "6765",
14
  "merchant": {
15
    "identifier": {
16
      "subcode": "string",
17
      "mid": "string",
18
      "sid": "string",
19
      "tid": "string",
20
      "merchant_type": "string",
21
      "merchant_genre": "string",
22
      "onboarding_type": "string"
23
    },
24
    "name": {
25
      "brand": "Brand Name",
26
      "legal": "Legal Name",
27
      "franchise": "Franchise Name"
28
    },
29
    "ownership": {
30
      "type": "Private"
31
    }
32
  },
33
  "feature_tags": [
34
    "mandate",
35
    "credit"
36
  ]
37
}
Request Parameters
upi_number

*

string

The UPI number to check for availability (mobile or numeric id).

device

*

object

The device details.

Show child parameters (2)

Response Parameters
entity
string

Collection of entity. Here it is upi_number.

number
string

The UPI number.

upi_transaction_id
string

Unique transaction id created by the originator.

vpa
string

VPA linked to the UPI number.

fundsource
string

The fundsource details.

Show child parameters (3)

is_merchant_vpa
boolean

Indicates if the VPA is a business VPA.

  • true: VPA is a business VPA.
  • false: VPA is not a business VPA.

is_merchant_verified
boolean

Indicates if the merchant is verified.

  • true: Merchant is verified.
  • false: Merchant is not verified.

mcc
string

Merchant Category Code.

merchant
object

Merchant details.

Show child parameters (3)

feature
array

List of special features tagged with this VPA.

Resolve UPI Number

POST
/v1/upi/tpap/upi_number/resolve

Click to copy

Use this endpoint to resolve a UPI number into VPA, name, IFSC, and business information.

Is this page helpful?

Request Parameters
upi_number

*

string

The UPI number to check for availability (mobile or numeric id).

device

*

object

The device details.

Show child parameters (2)

Response Parameters
entity
string

Collection of entity. Here it is upi_number.

number
string

The UPI number.

upi_transaction_id
string

Unique transaction id created by the originator.

vpa
string

VPA linked to the UPI number.

fundsource
string

The fundsource details.

Show child parameters (3)

is_merchant_vpa
boolean

Indicates if the VPA is a business VPA.

  • true: VPA is a business VPA.
  • false: VPA is not a business VPA.

is_merchant_verified
boolean

Indicates if the merchant is verified.

  • true: Merchant is verified.
  • false: Merchant is not verified.

mcc
string

Merchant Category Code.

merchant
object

Merchant details.

Show child parameters (3)

feature
array

List of special features tagged with this VPA.

Curl

1
-X POST 'https://api.rzp.<bank>.com/v1/upi/tpap/upi_number/resolve' \
2
-u [YOUR_KEY_ID]:[YOUR_SECRET] \
3
-H "Content-Type: application/json" \
4
-H "x-device-fingerprint: <device_fingerprint>" \
5
-H "x-device-fingerprint-timestamp: 1496918882000" \
6
-H "x-customer-reference: cust_ref" \
7
-d '{
8
  "upi_number": "9898989898",
9
  "device": {
10
    "geocode": "12.34,77.13",
11
    "ip": "198.1.1.1"
12
  }
13
}'

Response

Failure

1
{
2
  "entity": "upi_number",
3
  "number": "9898989898",
4
  "upi_transaction_id": "TXNxmms",
5
  "vpa": "gaurav.kumar@rzpa",
6
  "fundsource": {
7
    "customer_name": "kunal1",
8
    "ifsc": "SBI00001",
9
    "upi_iin": ""
10
  },
11
  "is_merchant_vpa": true,
12
  "is_merchant_verified": true,
13
  "mcc": "6765",
14
  "merchant": {
15
    "identifier": {
16
      "subcode": "string",
17
      "mid": "string",
18
      "sid": "string",
19
      "tid": "string",
20
      "merchant_type": "string",
21
      "merchant_genre": "string",
22
      "onboarding_type": "string"
23
    },
24
    "name": {
25
      "brand": "Brand Name",
26
      "legal": "Legal Name",
27
      "franchise": "Franchise Name"
28
    },
29
    "ownership": {
30
      "type": "Private"
31
    }
32
  },
33
  "feature_tags": [
34
    "mandate",
35
    "credit"
36
  ]
37
}