API Test Keys

Deregister Fundsource Lite with Balance

POST

/v1/upi/tpap/fundsource_lite/{:liteId}/deregister

Click to copy

Use this endpoint to deregister a Fundsource Lite account with balance and move the remaining balance to the user's bank account.

Is this page helpful?

Curl

1curl -X POST 'https://api.rzp.<bank>.com/v1/upi/tpap/fundsource_lite/{:lite_id}/deregister' \
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": "RZP1KuSUGrp2l6MmPuT0163789452QPAY02",
9  "reference_id": "RSKwpINfSkdEvtdxf",
10  "initiation_mode": "00",
11  "device": {
12    "geocode": "12.9667,77.5668",
13    "ip": "198.1.1.3"
14  },
15  "currency": "INR",
16  "amount": 100,
17  "description": "Deregister active Lite account",
18  "upi_credentials": {
19    "ARQC": "{\"type\":\"ARQC\",\"subType\":\"initial\",\"data\":{\"encryptedBase64String\":\"encrypted_string\",\"code\":\"NPCI-LITE\"}}"
20  },
21  "payees": [
22    {
23      "fundsource_id": "fs_Mock14charID"
24    }
25  ]
26}'

Success

1{
2  "entity": "upi.fundsource_lite",
3  "id": "lite_id",
4  "upi_lite_reference_number": "1234567890",
5  "upi_transaction_id": "RZPc2ed455b797e4add8392110cfc528acc",
6  "status": "deregistered",
7  "upi_lite_credentials": {
8    "ARQC": "string"
9  },
10  "fundsource": {
11    "id": "fs_1234",
12    "entity": "upi.fundsource",
13    "type": "savings",
14    "customer_name": "Gaurav Kumar",
15    "masked_account_number": "XXXXXX5199",
16    "account_reference_number": "999988126236990",
17    "ifsc": "HDFC000001",
18    "upi_pin_set": true,
19    "upi_pin_length": 6,
20    "otp_length": 6,
21    "atm_pin_length": 4,
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      "upi_lite_allowed": true
29    },
30    "vpas": {
31      "entity": "collection",
32      "count": 1,
33      "items": [
34        {
35          "mobile": "9999999999",
36          "address": "vpa@handle",
37          "status": "active",
38          "primary": true
39        }
40      ]
41    }
42  }
43}

Request Parameters

upi_transaction_id

string

Unique UPI transaction id.

reference_id

string

Merchant reference id.

upi_initiation_mode

enum

Indicates the 2-digit code defined by NPCI. Possible values:

00: Default - When no specific code is assigned or for general default scenarios.
01: QR Code - For making payments by scanning a standard QR code.
02: Secure QR Code - For payments that require additional security with QR codes.
03: Bharat QR Code - For interoperable payments across various payment networks using Bharat QR.
04: Intent - For payments initiated by an intent from an application or browser.
05: Secure Intent - For payments initiated by a secure intent from an app or browser.
06: NFC (Near Field Communication) - For contactless payments using NFC technology.
07: BLE (Bluetooth) - For payments made through Bluetooth Low Energy technology.
08: UHF (Ultra High Frequency) - For payments made using UHF technology, typically for toll payments.
09: Aadhaar - For payments authenticated using an Aadhaar number and biometric verification.
10: SDK (Software Development Kit) - For payments initiated through an SDK embedded in an app.
11: UPI-Mandate - For setting up recurring payments or mandates using UPI.
12: FIR (Foreign Inward Remittance) - For receiving remittances from foreign countries.
13: QR Mandate - For setting up recurring payments using a QR code.
14: BBPS - For making bill payments through the Bharat Bill Payment System.

device

object

The device details.

Show child parameters (2)

currency

string

The currency in which the payment should be made by the customer. For example, INR.

amount

integer

The amount to be paid by the customer in currency subunits. For example, if the amount is ₹100.00, enter 10000

description

string

Description of the payment.

upi_credentials

object

ARQC encrypted credential for authorisation.

Show child parameters (1)

payees

string

Payee details.

Show child parameters (1)

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_lite_credentials

object

ARQC encrypted credential for authorisation.

Show child parameters (1)

fundsource

object

The fundsource for which Lite is enabled.

Show child parameters (13)

Deregister Fundsource Lite with Balance

POST

/v1/upi/tpap/fundsource_lite/{:liteId}/deregister

Click to copy

Use this endpoint to deregister a Fundsource Lite account with balance and move the remaining balance to the user's bank account.

Is this page helpful?

Request Parameters

upi_transaction_id

string

Unique UPI transaction id.

reference_id

string

Merchant reference id.

upi_initiation_mode

enum

Indicates the 2-digit code defined by NPCI. Possible values:

00: Default - When no specific code is assigned or for general default scenarios.
01: QR Code - For making payments by scanning a standard QR code.
02: Secure QR Code - For payments that require additional security with QR codes.
03: Bharat QR Code - For interoperable payments across various payment networks using Bharat QR.
04: Intent - For payments initiated by an intent from an application or browser.
05: Secure Intent - For payments initiated by a secure intent from an app or browser.
06: NFC (Near Field Communication) - For contactless payments using NFC technology.
07: BLE (Bluetooth) - For payments made through Bluetooth Low Energy technology.
08: UHF (Ultra High Frequency) - For payments made using UHF technology, typically for toll payments.
09: Aadhaar - For payments authenticated using an Aadhaar number and biometric verification.
10: SDK (Software Development Kit) - For payments initiated through an SDK embedded in an app.
11: UPI-Mandate - For setting up recurring payments or mandates using UPI.
12: FIR (Foreign Inward Remittance) - For receiving remittances from foreign countries.
13: QR Mandate - For setting up recurring payments using a QR code.
14: BBPS - For making bill payments through the Bharat Bill Payment System.

device

object

The device details.

Show child parameters (2)

currency

string

The currency in which the payment should be made by the customer. For example, INR.

amount

integer

The amount to be paid by the customer in currency subunits. For example, if the amount is ₹100.00, enter 10000

description

string

Description of the payment.

upi_credentials

object

ARQC encrypted credential for authorisation.

Show child parameters (1)

payees

string

Payee details.

Show child parameters (1)

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_lite_credentials

object

ARQC encrypted credential for authorisation.

Show child parameters (1)

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/{:lite_id}/deregister' \
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": "RZP1KuSUGrp2l6MmPuT0163789452QPAY02",
9  "reference_id": "RSKwpINfSkdEvtdxf",
10  "initiation_mode": "00",
11  "device": {
12    "geocode": "12.9667,77.5668",
13    "ip": "198.1.1.3"
14  },
15  "currency": "INR",
16  "amount": 100,
17  "description": "Deregister active Lite account",
18  "upi_credentials": {
19    "ARQC": "{\"type\":\"ARQC\",\"subType\":\"initial\",\"data\":{\"encryptedBase64String\":\"encrypted_string\",\"code\":\"NPCI-LITE\"}}"
20  },
21  "payees": [
22    {
23      "fundsource_id": "fs_Mock14charID"
24    }
25  ]
26}'

Success

1{
2  "entity": "upi.fundsource_lite",
3  "id": "lite_id",
4  "upi_lite_reference_number": "1234567890",
5  "upi_transaction_id": "RZPc2ed455b797e4add8392110cfc528acc",
6  "status": "deregistered",
7  "upi_lite_credentials": {
8    "ARQC": "string"
9  },
10  "fundsource": {
11    "id": "fs_1234",
12    "entity": "upi.fundsource",
13    "type": "savings",
14    "customer_name": "Gaurav Kumar",
15    "masked_account_number": "XXXXXX5199",
16    "account_reference_number": "999988126236990",
17    "ifsc": "HDFC000001",
18    "upi_pin_set": true,
19    "upi_pin_length": 6,
20    "otp_length": 6,
21    "atm_pin_length": 4,
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      "upi_lite_allowed": true
29    },
30    "vpas": {
31      "entity": "collection",
32      "count": 1,
33      "items": [
34        {
35          "mobile": "9999999999",
36          "address": "vpa@handle",
37          "status": "active",
38          "primary": true
39        }
40      ]
41    }
42  }
43}