API Test Keys

Create a VPA and Link to Payment Source

POST

/v1/upi/tpap/vpa/link?expand[]=fundsources

Click to copy

If not already linked, create a VPA and link it with a list of payment sources. The expansion in the request URL returns the expanded payment source if it is passed in the query parameters. Use this endpoint to create a VPA and link it to a payment source.

Is this page helpful?

Curl

1curl -X POST 'api.rzp.<bank>.com/v1/upi/tpap/vpa/link?expand[]=fundsources' \
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  "vpa":"customer@handle",
9  "fundsources":[
10    {
11    "fundsource_id":"fs_1234",
12    "primary":true
13    }
14  ]
15}'

Response

1{
2  "entity":"upi.vpa",
3  "customer_reference":"cust_1234",
4  "mobile":"999999999",
5  "address":"kunal-1@rzpa",
6  "status":"active",
7  "fundsources":{
8    "entity":"collection",
9    "count":2,
10    "items":[
11      {
12        "id":"fs_1234",
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":"format1",
47          "logo_url":"<bank logo url>"
48        }
49      }
50    ]
51  }
52}

Request Parameters

vpa

string

The VPA that should be linked.

fundsources

array

The list of payment sources that should be linked with the requested VPA.

Show child parameters (2)

Response Parameters

entity

string

The name of the entity. Here, it is upi.vpa.

customer_reference

string

The customer identifier. You must pass the customer identifier at the TPAP end in this attribute.

mobile

string

The mobile number of the VPA linked to the payment source.

address

string

The VPA of the customer.

status

string

The VPA and payment source linking status. Possible values:

active
inactive

fundsources

object

Collection of payment sources.

Show child parameters (3)

Create a VPA and Link to Payment Source

POST

/v1/upi/tpap/vpa/link?expand[]=fundsources

Click to copy

Is this page helpful?

Request Parameters

vpa

string

The VPA that should be linked.

fundsources

array

The list of payment sources that should be linked with the requested VPA.

Show child parameters (2)

Response Parameters

entity

string

The name of the entity. Here, it is upi.vpa.

customer_reference

string

The customer identifier. You must pass the customer identifier at the TPAP end in this attribute.

mobile

string

The mobile number of the VPA linked to the payment source.

address

string

The VPA of the customer.

status

string

The VPA and payment source linking status. Possible values:

active
inactive

fundsources

object

Collection of payment sources.

Show child parameters (3)

Curl

1curl -X POST 'api.rzp.<bank>.com/v1/upi/tpap/vpa/link?expand[]=fundsources' \
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  "vpa":"customer@handle",
9  "fundsources":[
10    {
11    "fundsource_id":"fs_1234",
12    "primary":true
13    }
14  ]
15}'

Response

1{
2  "entity":"upi.vpa",
3  "customer_reference":"cust_1234",
4  "mobile":"999999999",
5  "address":"kunal-1@rzpa",
6  "status":"active",
7  "fundsources":{
8    "entity":"collection",
9    "count":2,
10    "items":[
11      {
12        "id":"fs_1234",
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":"format1",
47          "logo_url":"<bank logo url>"
48        }
49      }
50    ]
51  }
52}