API Test Keys

Delete VPAs

DELETE

/v1/upi/tpap/vpa?vpa=gaurav@okhdfcbank

Click to copy

Use this endpoint to delete a VPA of a customer.

Is this page helpful?

Curl

1curl -X DELETE 'api.rzp.<bank>.com/v1/upi/tpap/vpa?vpa=gaurav@okhdfcbank' \
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" \

Response

1{
2  "entity":"upi.vpa",
3  "customer_reference":"PXYZ",
4  "vpa":"gaurav@okhdfcbank",
5  "status":"deleted",
6  "mobile":"999999999",
7  "fundsources_unlinked":{
8    "entity":"collection",
9    "count":2,
10    "items":[
11      {
12        "id":"dummyfs1111111",
13        "customer_name":"kunal1",
14        "masked_account_number":"xxxxxx8990",
15        "account_reference_number":"999988126236990",
16        "type":"savings",
17        "ifsc":"SBI00001",
18        "upi_pin_set":true,
19        "upi_pin_length":4,
20        "otp_length":4,
21        "atm_pin_length":6,
22        "fundsource_provider":{
23          "name":"HDFC Bank",
24          "upi_iin":"600007",
25          "upi_enabled":false,
26          "mobile_registration_format":"format1",
27          "logo_url":"<bank logo url>"
28        },
29        "primary":true
30      },
31      {
32        "id":"dummyfs1111111",
33        "customer_name":"kunal1",
34        "masked_account_number":"xxxxxx8990",
35        "account_reference_number":"999988126236990",
36        "type":"savings",
37        "ifsc":"SBI00001",
38        "upi_pin_set":true,
39        "upi_pin_length":4,
40        "otp_length":4,
41        "atm_pin_length":6,
42        "fundsource_provider":{
43          "name":"HDFC Bank",
44          "upi_iin":"600007",
45          "upi_enabled":false,
46          "mobile_registration_format":"format2",
47          "logo_url":"<bank logo url>"
48        },
49        "primary":true
50      }
51    ]
52  }
53}

Query Parameters

vpa

string

The VPA that should be deleted.

Response Parameters

entity

string

This refers to the collection of entity. Here, it is vpa.

customer_reference

string

The customer identifier.

vpa

string

This is the VPA which needs to be de-linked.

status

enum

Status of the action. Possible value is deleted if the VPA is deleted.

mobile

string

The mobile number of the customer.

fundsources_unlinked

array

The unlinked payment source details.

Show child parameters (3)

Delete VPAs

DELETE

/v1/upi/tpap/vpa?vpa=gaurav@okhdfcbank

Click to copy

Use this endpoint to delete a VPA of a customer.

Is this page helpful?

Query Parameters

vpa

string

The VPA that should be deleted.

Response Parameters

entity

string

This refers to the collection of entity. Here, it is vpa.

customer_reference

string

The customer identifier.

vpa

string

This is the VPA which needs to be de-linked.

status

enum

Status of the action. Possible value is deleted if the VPA is deleted.

mobile

string

The mobile number of the customer.

fundsources_unlinked

array

The unlinked payment source details.

Show child parameters (3)

Curl

1curl -X DELETE 'api.rzp.<bank>.com/v1/upi/tpap/vpa?vpa=gaurav@okhdfcbank' \
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" \

Response

1{
2  "entity":"upi.vpa",
3  "customer_reference":"PXYZ",
4  "vpa":"gaurav@okhdfcbank",
5  "status":"deleted",
6  "mobile":"999999999",
7  "fundsources_unlinked":{
8    "entity":"collection",
9    "count":2,
10    "items":[
11      {
12        "id":"dummyfs1111111",
13        "customer_name":"kunal1",
14        "masked_account_number":"xxxxxx8990",
15        "account_reference_number":"999988126236990",
16        "type":"savings",
17        "ifsc":"SBI00001",
18        "upi_pin_set":true,
19        "upi_pin_length":4,
20        "otp_length":4,
21        "atm_pin_length":6,
22        "fundsource_provider":{
23          "name":"HDFC Bank",
24          "upi_iin":"600007",
25          "upi_enabled":false,
26          "mobile_registration_format":"format1",
27          "logo_url":"<bank logo url>"
28        },
29        "primary":true
30      },
31      {
32        "id":"dummyfs1111111",
33        "customer_name":"kunal1",
34        "masked_account_number":"xxxxxx8990",
35        "account_reference_number":"999988126236990",
36        "type":"savings",
37        "ifsc":"SBI00001",
38        "upi_pin_set":true,
39        "upi_pin_length":4,
40        "otp_length":4,
41        "atm_pin_length":6,
42        "fundsource_provider":{
43          "name":"HDFC Bank",
44          "upi_iin":"600007",
45          "upi_enabled":false,
46          "mobile_registration_format":"format2",
47          "logo_url":"<bank logo url>"
48        },
49        "primary":true
50      }
51    ]
52  }
53}