API Test Keys

Register Fundsource Lite

POST

/v1/upi/tpap/fundsource_lite

Click to copy

Use this endpoint to activate a Fundsource Lite account.

Is this page helpful?

Curl

1curl -X POST 'https://api.rzp.<bank>.com/v1/upi/tpap/fundsource_lite' \
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: cust_ref" \
7-d '{
8  "upi_transaction_id": "123qwert12",
9  "operation_type": "registration",
10  "challenge": "string",
11  "fundsource_id": "fs_id"
12}'

Success

1{
2  "entity": "upi.fundsource_lite",
3  "id": "lite_id",
4  "upi_lite_reference_number": "1234567890",
5  "upi_transaction_id": "RZP1KuSUGrp2l6MmPuT0163789452QPAY02",
6  "status": "active",
7  "upi_keys": "xml keys from NPCI without tampering",
8  "fundsource": {
9    "id": "fs_1234",
10    "entity": "upi.fundsource",
11    "type": "savings",
12    "customer_name": "Gaurav Kumar",
13    "masked_account_number": "XXXXXX5199",
14    "account_reference_number": "999988126236990",
15    "ifsc": "HDFC000001",
16    "upi_pin_set": true,
17    "upi_pin_length": 6,
18    "otp_length": 6,
19    "atm_pin_length": 4,
20    "fundsource_provider": {
21      "name": "HDFC Bank",
22      "upi_iin": "600007",
23      "upi_enabled": false,
24      "mobile_registration_format": "format1",
25      "logo_url": "<bank logo url>",
26      "upi_lite_allowed": true
27    },
28    "vpas": {
29      "entity": "collection",
30      "count": 1,
31      "items": [
32        {
33          "mobile": "9999999999",
34          "address": "vpa@handle",
35          "status": "active",
36          "primary": true
37        }
38      ]
39    }
40  }
41}

Request Parameters

upi_transaction_id

string

Unique identifier of the transaction across UPI entities. Must start with a Switch-issued prefix. For example, 123qwert12.

operation_type

enum

Type of operation being performed. Possible values:

registration
rotation

challenge

string

Challenge received from common library during get challenge process.

fundsource_id

string

Fundsource id for which Lite is to be enabled.

Response Parameters

entity

string

Name of the entity. Here it is upi.fundsource_lite.

id

string

Unique identifier for the Fundsource Lite entity.

upi_lite_reference_number

string

Reference number for the Lite account, assigned by the originator.

upi_transaction_id

string

Unique UPI transaction identifier.

status

string

Current status of the UPI Lite account. Possible values:

initiated
active
deregistered

upi_keys

string

XML credentials from NPCI used by common library.

fundsource

object

The fundsource for which Lite is enabled.

Show child parameters (13)

Register Fundsource Lite

POST

/v1/upi/tpap/fundsource_lite

Click to copy

Use this endpoint to activate a Fundsource Lite account.

Is this page helpful?

Request Parameters

upi_transaction_id

string

Unique identifier of the transaction across UPI entities. Must start with a Switch-issued prefix. For example, 123qwert12.

operation_type

enum

Type of operation being performed. Possible values:

registration
rotation

challenge

string

Challenge received from common library during get challenge process.

fundsource_id

string

Fundsource id for which Lite is to be enabled.

Response Parameters

entity

string

Name of the entity. Here it is upi.fundsource_lite.

id

string

Unique identifier for the Fundsource Lite entity.

upi_lite_reference_number

string

Reference number for the Lite account, assigned by the originator.

upi_transaction_id

string

Unique UPI transaction identifier.

status

string

Current status of the UPI Lite account. Possible values:

initiated
active
deregistered

upi_keys

string

XML credentials from NPCI used by common library.

fundsource

object

The fundsource for which Lite is enabled.

Show child parameters (13)

Curl

1curl -X POST 'https://api.rzp.<bank>.com/v1/upi/tpap/fundsource_lite' \
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: cust_ref" \
7-d '{
8  "upi_transaction_id": "123qwert12",
9  "operation_type": "registration",
10  "challenge": "string",
11  "fundsource_id": "fs_id"
12}'

Success

1{
2  "entity": "upi.fundsource_lite",
3  "id": "lite_id",
4  "upi_lite_reference_number": "1234567890",
5  "upi_transaction_id": "RZP1KuSUGrp2l6MmPuT0163789452QPAY02",
6  "status": "active",
7  "upi_keys": "xml keys from NPCI without tampering",
8  "fundsource": {
9    "id": "fs_1234",
10    "entity": "upi.fundsource",
11    "type": "savings",
12    "customer_name": "Gaurav Kumar",
13    "masked_account_number": "XXXXXX5199",
14    "account_reference_number": "999988126236990",
15    "ifsc": "HDFC000001",
16    "upi_pin_set": true,
17    "upi_pin_length": 6,
18    "otp_length": 6,
19    "atm_pin_length": 4,
20    "fundsource_provider": {
21      "name": "HDFC Bank",
22      "upi_iin": "600007",
23      "upi_enabled": false,
24      "mobile_registration_format": "format1",
25      "logo_url": "<bank logo url>",
26      "upi_lite_allowed": true
27    },
28    "vpas": {
29      "entity": "collection",
30      "count": 1,
31      "items": [
32        {
33          "mobile": "9999999999",
34          "address": "vpa@handle",
35          "status": "active",
36          "primary": true
37        }
38      ]
39    }
40  }
41}