API Test Keys

Bind the Device

POST

/v1/upi/tpap/devices/bind

Click to copy

Use this endpoint to bind the device.

Is this page helpful?

Request

1curl -X POST 'api.rzp.<bank>.com/v1/upi/tpap/devices/bind' \
2-u [YOUR_KEY_ID]:[YOUR_SECRET] \
3-H "Content-type: application/json" \
4-H "x-customer-reference: customer-id-from-customer" \
5-d '{
6  "mobile":"91999999999",
7  "verification_type":"sms",
8  "sms":{
9    "content":"UPIACT ad56ef90396348bac56099"
10  },
11  "uuid":"<device_id>",
12  "app":"test.merchant.upi.com",
13  "ssid":"123456789",
14  "manufacturer":"samsung",
15  "model":"Galaxy S23",
16  "os":"android",
17  "os_version":"Dev12345"
18}'

Response

1{
2  "entity":"upi.device",
3  "mobile":"999999999",
4  "uuid":"<device_id>",
5  "app":"test.merchant.upi.com",
6  "ssid":"123456789",
7  "manufacturer":"samsung",
8  "model":"Galaxy S23",
9  "os":"android",
10  "os_version":"Dev12345",
11  "status":"verified"
12}

Request Parameters

mobile

string

Mobile number of the customer.

verification_type

string

The verification type. Possible value is sms.

sms

object

The device details.

Show child parameters (1)

device

object

The device information. This should be the same information sent when you

get the verification token api

Show child parameters (7)

Response Parameters

entity

string

Indicates the type of entity. Here it is, device.

mobile

string

The mobile number of the customer.

uuid

string

The unique identifier of the device. For example, advertising_id or android_id.

app

string

The package name for the app.

ssid

string

The service set identifier (unique network identifier).

manufacturer

string

The phone manufacturer.

model

string

The phone model. For example, Galaxy S23.

os

string

The operating system running on the device.

os_version

string

The version of the operating system.

status

string

Device binding status. Know more about the

device binding status

Bind the Device

POST

/v1/upi/tpap/devices/bind

Click to copy

Use this endpoint to bind the device.

Is this page helpful?

Request Parameters

mobile

string

Mobile number of the customer.

verification_type

string

The verification type. Possible value is sms.

sms

object

The device details.

Show child parameters (1)

device

object

The device information. This should be the same information sent when you

get the verification token api

Show child parameters (7)

Response Parameters

entity

string

Indicates the type of entity. Here it is, device.

mobile

string

The mobile number of the customer.

uuid

string

The unique identifier of the device. For example, advertising_id or android_id.

app

string

The package name for the app.

ssid

string

The service set identifier (unique network identifier).

manufacturer

string

The phone manufacturer.

model

string

The phone model. For example, Galaxy S23.

os

string

The operating system running on the device.

os_version

string

The version of the operating system.

status

string

Device binding status. Know more about the

device binding status

Request

1curl -X POST 'api.rzp.<bank>.com/v1/upi/tpap/devices/bind' \
2-u [YOUR_KEY_ID]:[YOUR_SECRET] \
3-H "Content-type: application/json" \
4-H "x-customer-reference: customer-id-from-customer" \
5-d '{
6  "mobile":"91999999999",
7  "verification_type":"sms",
8  "sms":{
9    "content":"UPIACT ad56ef90396348bac56099"
10  },
11  "uuid":"<device_id>",
12  "app":"test.merchant.upi.com",
13  "ssid":"123456789",
14  "manufacturer":"samsung",
15  "model":"Galaxy S23",
16  "os":"android",
17  "os_version":"Dev12345"
18}'

Response

1{
2  "entity":"upi.device",
3  "mobile":"999999999",
4  "uuid":"<device_id>",
5  "app":"test.merchant.upi.com",
6  "ssid":"123456789",
7  "manufacturer":"samsung",
8  "model":"Galaxy S23",
9  "os":"android",
10  "os_version":"Dev12345",
11  "status":"verified"
12}