API Test Keys

Fetch Payment Sources

GET

/v1/upi/tpap/fundsources?refresh=true&linked=true&upi_iin=7078129&skip=0&count=10&device_ip=198.1.1.1&device_geocode=1234.1213

Click to copy

Payment sources are any payment account (Bank Account, PPI, Wallets, Mobile Money, and so on) offered by a regulated entity where money can be held, debited, and credited. Use this endpoint to fetch banks or fundsource providers. After a customer selects a bank, TPAP uses this API to fetch a list of payment sources. Based on the query parameters, the TPAP has the option to get fundsources in real time for NPCI, or get only VPA-linked fundsource or get only fundsources for a particular bank.

Is this page helpful?

Curl

1curl -X GET 'api.rzp.<bank>.com/v1/upi/tpap/fundsources?refresh=true&linked=true&upi_iin=7078129&skip=0&count=10&device_ip=198.1.1.1&device_geocode=1234.1213' \
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":"fs_1234",
7      "entity":"upi.fundsource",
8      "type":"savings",
9      "customer_name":"Gaurav Kumar",
10      "masked_account_number":"XXXXXX5199",
11      "account_reference_number":"999988126236990",
12      "ifsc":"HDFC000001",
13      "upi_pin_set":true,
14      "upi_pin_length":6,
15      "otp_length":6,
16      "atm_pin_length":4,
17      "fundsource_provider":{
18        "name":"HDFC Bank",
19        "upi_iin":"600007",
20        "upi_enabled":false,
21        "mobile_registration_format":"format1",
22        "logo_url":"<bank logo url>"
23      },
24      "vpas":{
25        "entity":"upi.collection",
26        "count":1,
27        "items":[
28          {
29            "mobile":"9999999999",
30            "address":"vpa@handle",
31            "status":"active",
32            "primary":true
33          }
34        ]
35      }
36    }
37  ]
38}

Query Parameters

refresh

boolean

If this parameter is true, data is fetched via NPCI. We recommend passing this as true when customers are trying to link their bank accounts. If this is false, data stored at PSP is fetched.

upi_iin

string

IIN of the bank returned in the response of the Fetch Fund Source Providers API. Use the IIN of the bank selected by the customer. IIN is not mandatory if this parameter value is false.

skip

integer

Number of entities to skip. Default is 10. You can use this parameter for pagination in combination with skip.

count

integer

Number of entities to fetch. Default is 0. You can use this parameter for pagination in combination with count.

device_ip

string

IP address of the device. For example, 123.456.123.123.

device_geocode

string

Location coordinates of the device. For example, 12.9667,77.5667.

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 (13)

Fetch Payment Sources

GET

/v1/upi/tpap/fundsources?refresh=true&linked=true&upi_iin=7078129&skip=0&count=10&device_ip=198.1.1.1&device_geocode=1234.1213

Click to copy

Is this page helpful?

Query Parameters

refresh

boolean

If this parameter is true, data is fetched via NPCI. We recommend passing this as true when customers are trying to link their bank accounts. If this is false, data stored at PSP is fetched.

upi_iin

string

IIN of the bank returned in the response of the Fetch Fund Source Providers API. Use the IIN of the bank selected by the customer. IIN is not mandatory if this parameter value is false.

skip

integer

Number of entities to skip. Default is 10. You can use this parameter for pagination in combination with skip.

count

integer

Number of entities to fetch. Default is 0. You can use this parameter for pagination in combination with count.

device_ip

string

IP address of the device. For example, 123.456.123.123.

device_geocode

string

Location coordinates of the device. For example, 12.9667,77.5667.

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 (13)

Curl

1curl -X GET 'api.rzp.<bank>.com/v1/upi/tpap/fundsources?refresh=true&linked=true&upi_iin=7078129&skip=0&count=10&device_ip=198.1.1.1&device_geocode=1234.1213' \
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":"fs_1234",
7      "entity":"upi.fundsource",
8      "type":"savings",
9      "customer_name":"Gaurav Kumar",
10      "masked_account_number":"XXXXXX5199",
11      "account_reference_number":"999988126236990",
12      "ifsc":"HDFC000001",
13      "upi_pin_set":true,
14      "upi_pin_length":6,
15      "otp_length":6,
16      "atm_pin_length":4,
17      "fundsource_provider":{
18        "name":"HDFC Bank",
19        "upi_iin":"600007",
20        "upi_enabled":false,
21        "mobile_registration_format":"format1",
22        "logo_url":"<bank logo url>"
23      },
24      "vpas":{
25        "entity":"upi.collection",
26        "count":1,
27        "items":[
28          {
29            "mobile":"9999999999",
30            "address":"vpa@handle",
31            "status":"active",
32            "primary":true
33          }
34        ]
35      }
36    }
37  ]
38}