API Test Keys

De-register Devices

POST

/v1/upi/tpap/devices/deregister

Click to copy

TPAP should de-register the device at Razorpay's end by calling this API whenever the customer removes the SIM from their mobile application. It can also be used in general to de-register the device. On de-registration, the customer's device binding, all VPAs, all fund sources, and their mappings are deleted. Use this endpoint to de-register the device.

Is this page helpful?

Curl

1curl -X POST 'api.rzp.<bank>.com/v1/upi/tpap/devices/deregister' \
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: customer-id-from-customer" \
7-d '{
8  "uuid":"<device_id>",
9  "app":"test.merchant.upi.com",
10  "ssid":"123456789",
11  "manufacturer":"samsung",
12  "model":"Galaxy S23",
13  "os":"android",
14  "os_version":"Dev12345"
15  }'

Response

1{
2  "status": "device_deregistered",
3  "mobile": "987654321",
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}

Request Parameters

uuid

string

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

app

string

The application package name.

ssid

string

The SIM identifier.

manufacturer

string

The device manufacturer.

model

string

The model of the device.

os

string

The operating system running on the device.

os_version

string

The version of the operating system.

Response Parameters

status

enum

Status of the de-registration. Possible values:

device_deregistered
device_deregisteration_failed

uuid

string

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

app

string

The application package name.

ssid

string

The SIM identifier.

manufacturer

string

The phone manufacturer.

model

string

The model of the phone.

os

string

The operating system running on the device.

os_version

string

The version of the operating system on the device.

De-register Devices

POST

/v1/upi/tpap/devices/deregister

Click to copy

Is this page helpful?

Request Parameters

uuid

string

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

app

string

The application package name.

ssid

string

The SIM identifier.

manufacturer

string

The device manufacturer.

model

string

The model of the device.

os

string

The operating system running on the device.

os_version

string

The version of the operating system.

Response Parameters

status

enum

Status of the de-registration. Possible values:

device_deregistered
device_deregisteration_failed

uuid

string

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

app

string

The application package name.

ssid

string

The SIM identifier.

manufacturer

string

The phone manufacturer.

model

string

The model of the phone.

os

string

The operating system running on the device.

os_version

string

The version of the operating system on the device.

Curl

1curl -X POST 'api.rzp.<bank>.com/v1/upi/tpap/devices/deregister' \
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: customer-id-from-customer" \
7-d '{
8  "uuid":"<device_id>",
9  "app":"test.merchant.upi.com",
10  "ssid":"123456789",
11  "manufacturer":"samsung",
12  "model":"Galaxy S23",
13  "os":"android",
14  "os_version":"Dev12345"
15  }'

Response

1{
2  "status": "device_deregistered",
3  "mobile": "987654321",
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}