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

Available

API Test Keys

Check UPI Number Availability

POST
/v1/upi/tpap/upi_number/available

Click to copy

Use this endpoint to check if a specific Mobile UPI Number is available.

Is this page helpful?

Curl

1
-X POST 'https://api.rzp.<bank>.com/v1/upi/tpap/upi_number/available' \
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": "1234567890",
9
  "vpa": "gaurav.kumar@exampleupi",
10
  "action": "create",
11
  "consent": true
12
}'

Success

Failure

1
{
2
  "upi_number": "1234567890",
3
  "type": "mobile",
4
  "vpa": "gaurav.kumar@exampleupi",
5
  "upi_transaction_id": "123qwert12",
6
  "available": true,
7
  "existing_vpa": "olduser@upi"
8
}
Request Parameters
upi_number

*

string

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

vpa

*

string

VPA to which the number is mapped.

action

*

string

Action to be performed on UPI Number. Possible values:

  • create
  • port

consent

*

boolean

Consent of the user to check the UPI number is available. Possible values:

  • true: The user has given the consent.
  • false: The user has not given the consent.

Response Parameters
upi_number
string

Unique id mapped to the customer's VPA.

type
string

Type of number. For example, mobile or numeric.

vpa
string

VPA linked to the UPI number.

upi_transaction_id
string

Unique transaction id created by the originator.

available
boolean

Indicates if the number is available.

  • true: Number is available.
  • false: Number is not available.

existing_vpa
string

VPA linked with the UPI number.

Check UPI Number Availability

POST
/v1/upi/tpap/upi_number/available

Click to copy

Use this endpoint to check if a specific Mobile UPI Number is available.

Is this page helpful?

Request Parameters
upi_number

*

string

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

vpa

*

string

VPA to which the number is mapped.

action

*

string

Action to be performed on UPI Number. Possible values:

  • create
  • port

consent

*

boolean

Consent of the user to check the UPI number is available. Possible values:

  • true: The user has given the consent.
  • false: The user has not given the consent.

Response Parameters
upi_number
string

Unique id mapped to the customer's VPA.

type
string

Type of number. For example, mobile or numeric.

vpa
string

VPA linked to the UPI number.

upi_transaction_id
string

Unique transaction id created by the originator.

available
boolean

Indicates if the number is available.

  • true: Number is available.
  • false: Number is not available.

existing_vpa
string

VPA linked with the UPI number.

Curl

1
-X POST 'https://api.rzp.<bank>.com/v1/upi/tpap/upi_number/available' \
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": "1234567890",
9
  "vpa": "gaurav.kumar@exampleupi",
10
  "action": "create",
11
  "consent": true
12
}'

Success

Failure

1
{
2
  "upi_number": "1234567890",
3
  "type": "mobile",
4
  "vpa": "gaurav.kumar@exampleupi",
5
  "upi_transaction_id": "123qwert12",
6
  "available": true,
7
  "existing_vpa": "olduser@upi"
8
}