API Test Keys

Create or Port UPI Number

POST

/v1/upi/tpap/upi_number

Click to copy

Use this endpoint to create a new UPI Number or port a mobile number to a new VPA.

Is this page helpful?

Curl

1-X POST 'https://api.rzp.<bank>.com/v1/upi/tpap/upi_number' \
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  "existing_vpa": "olduser@upi",
12  "consent": true
13}'

Response

Failure

1{
2  "entity": "upi_number",
3  "upi_transaction_id": "123qwert12",
4  "upi_number": "1234567890",
5  "type": "mobile",
6  "status": "initiated",
7  "vpa": "gaurav.kumar@exampleupi"
8}

Request Parameters

upi_number

string

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

vpa

string

VPA to which the UPI number has to be linked.

action

string

Action to be performed on UPI Number. Possible values:

create
port

existing_vpa

string

VPA linked with the UPI number (Only in case of PORT).

consent

boolean

Consent of the user to create a new UPI Number or port a mobile number to a new VPA. Possible values:

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

Response Parameters

entity

string

Collection of entity. Here it is upi_number.

upi_transaction_id

string

Unique transaction id created by the originator.

upi_number

string

Unique id mapped to the customer's VPA.

type

string

Type of number. For example, mobile or numeric.

status

string

Status of the UPI number. Possible values:

initiated
active

vpa

string

VPA linked to the UPI number.

Create or Port UPI Number

POST

/v1/upi/tpap/upi_number

Click to copy

Use this endpoint to create a new UPI Number or port a mobile number to a new VPA.

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 UPI number has to be linked.

action

string

Action to be performed on UPI Number. Possible values:

create
port

existing_vpa

string

VPA linked with the UPI number (Only in case of PORT).

consent

boolean

Consent of the user to create a new UPI Number or port a mobile number to a new VPA. Possible values:

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

Response Parameters

entity

string

Collection of entity. Here it is upi_number.

upi_transaction_id

string

Unique transaction id created by the originator.

upi_number

string

Unique id mapped to the customer's VPA.

type

string

Type of number. For example, mobile or numeric.

status

string

Status of the UPI number. Possible values:

initiated
active

vpa

string

VPA linked to the UPI number.

Curl

1-X POST 'https://api.rzp.<bank>.com/v1/upi/tpap/upi_number' \
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  "existing_vpa": "olduser@upi",
12  "consent": true
13}'

Response

Failure

1{
2  "entity": "upi_number",
3  "upi_transaction_id": "123qwert12",
4  "upi_number": "1234567890",
5  "type": "mobile",
6  "status": "initiated",
7  "vpa": "gaurav.kumar@exampleupi"
8}