API Test Keys

Fetch UPI Numbers

GET

/v1/upi/tpap/upi_number

Click to copy

Use this endpoint to retrieve the list of UPI numbers mapped to a customer along with their statuses and available slots.

Is this page helpful?

Curl

1-X GET '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" \

Response

Failure

1{
2  "entity": "collection",
3  "mobile_linked": true,
4  "available_slots": 1,
5  "upi_numbers": [
6    {
7      "number": "9234567890",
8      "type": "mobile",
9      "vpa": "dummyuser2@upi",
10      "status": "active"
11    },
12    {
13      "number": "123456780",
14      "type": "numeric",
15      "vpa": "gaurav.kumar@exampleupi",
16      "status": "inactive"
17    }
18  ]
19}

Response Parameters

entity

string

Collection of entity. Here it is upi_number.

mobile_linked

boolean

Indicates if a mobile number is already linked.

true: Mobile number is linked.
false: Mobile number is not linked.

available_slots

integer

Number of available slots left (maximum is 3 per customer).

upi_number

string

Unique id mapped to the customer's VPA.

Show child parameters (4)

Fetch UPI Numbers

GET

/v1/upi/tpap/upi_number

Click to copy

Use this endpoint to retrieve the list of UPI numbers mapped to a customer along with their statuses and available slots.

Is this page helpful?

Response Parameters

entity

string

Collection of entity. Here it is upi_number.

mobile_linked

boolean

Indicates if a mobile number is already linked.

true: Mobile number is linked.
false: Mobile number is not linked.

available_slots

integer

Number of available slots left (maximum is 3 per customer).

upi_number

string

Unique id mapped to the customer's VPA.

Show child parameters (4)

Curl

1-X GET '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" \

Response

Failure

1{
2  "entity": "collection",
3  "mobile_linked": true,
4  "available_slots": 1,
5  "upi_numbers": [
6    {
7      "number": "9234567890",
8      "type": "mobile",
9      "vpa": "dummyuser2@upi",
10      "status": "active"
11    },
12    {
13      "number": "123456780",
14      "type": "numeric",
15      "vpa": "gaurav.kumar@exampleupi",
16      "status": "inactive"
17    }
18  ]
19}