API Test Keys

Fetch VPAs

GET

/v1/upi/tpap/vpas?status=”active”&skip=0&count=10

Click to copy

Use this endpoint to fetch all VPAs of a customer.

Is this page helpful?

Curl

1curl -X GET 'api.rzp.<bank>.com/v1/upi/tpap/vpas?status=”active”&skip=0&count=10' \
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":"collection",
3  "count":1,
4  "items":[
5    {
6      "id":"id",
7      "entity":"vpa",
8      "mobile":"999999999",
9      "address":"kunal-1@rzpa",
10      "status":"active",
11      "fundsources":{
12        "entity":"collection",
13        "count":2,
14        "items":[
15          {
16            "id":"dummyfs1111111",
17            "customer_name":"kunal1",
18            "masked_account_number":"xxxxxx8990",
19            "account_reference_number":"999988126236990",
20            "type":"savings",
21            "ifsc":"SBI00001",
22            "upi_pin_set":true,
23            "upi_pin_length":4,
24            "otp_length":4,
25            "atm_pin_length":6,
26            "fundsource_provider":{
27              "name":"HDFC Bank",
28              "upi_iin":"600007",
29              "upi_enabled":false,
30              "mobile_registration_format":"format1",
31              "logo_url":"<bank logo url>"
32            },
33            "primary":true
34          }
35        ]
36      }
37    }
38  ]
39}

Query Parameters

status

enum

Indicates the VPA and payment source linking status. Possible values:

active
inactive

skip

integer

The number of entities to skip. Default is 0. You can use this parameter for pagination in combination with skip.

count

integer

The number of entities to fetch. Default is 10. You can use this for pagination in combination with count.

Response Parameters

entity

string

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

count

integer

Indicates the number of item in the entity type.

items

array

Indicates a list of objects.

Show child parameters (6)

Fetch VPAs

GET

/v1/upi/tpap/vpas?status=”active”&skip=0&count=10

Click to copy

Use this endpoint to fetch all VPAs of a customer.

Is this page helpful?

Query Parameters

status

enum

Indicates the VPA and payment source linking status. Possible values:

active
inactive

skip

integer

The number of entities to skip. Default is 0. You can use this parameter for pagination in combination with skip.

count

integer

The number of entities to fetch. Default is 10. You can use this for pagination in combination with count.

Response Parameters

entity

string

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

count

integer

Indicates the number of item in the entity type.

items

array

Indicates a list of objects.

Show child parameters (6)

Curl

1curl -X GET 'api.rzp.<bank>.com/v1/upi/tpap/vpas?status=”active”&skip=0&count=10' \
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":"collection",
3  "count":1,
4  "items":[
5    {
6      "id":"id",
7      "entity":"vpa",
8      "mobile":"999999999",
9      "address":"kunal-1@rzpa",
10      "status":"active",
11      "fundsources":{
12        "entity":"collection",
13        "count":2,
14        "items":[
15          {
16            "id":"dummyfs1111111",
17            "customer_name":"kunal1",
18            "masked_account_number":"xxxxxx8990",
19            "account_reference_number":"999988126236990",
20            "type":"savings",
21            "ifsc":"SBI00001",
22            "upi_pin_set":true,
23            "upi_pin_length":4,
24            "otp_length":4,
25            "atm_pin_length":6,
26            "fundsource_provider":{
27              "name":"HDFC Bank",
28              "upi_iin":"600007",
29              "upi_enabled":false,
30              "mobile_registration_format":"format1",
31              "logo_url":"<bank logo url>"
32            },
33            "primary":true
34          }
35        ]
36      }
37    }
38  ]
39}