Introduction

API Reference Guide

API Changelog

Understand Razorpay APIs

Authentication

Sandbox Setup

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Subscriptions

Route

Smart Collect

TPAP Pro

Customer Onboarding

Accounts Management

Payments

Mandates

Complaints

UPI Number

UPI Lite

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Fetch Balance

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

Payments

Tpap Pro

Fundsource Lite

Top Up

API Test Keys

Top-up Fundsource Lite

POST
/v1/upi/tpap/payments/pay

Click to copy

Use this endpoint to add balance to Fundsource Lite account.

Is this page helpful?

Curl

1
curl -X POST 'https://api.rzp.<bank>.com/v1/upi/tpap/payments/pay' \
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": "QR Code",
11
  "upi_purpose_code": "42",
12
  "purpose": "UPI Lite Top Up",
13
  "device": {
14
    "geocode": "12.9667,77.5667",
15
    "ip": "198.1.1.1"
16
  },
17
  "currency": "INR",
18
  "amount": 100,
19
  "type": "pay",
20
  "description": "Upi-lite registration",
21
  "payer": {
22
    "vpa": "9560137963.stage@rzp",
23
    "fundsource_id": "fs_Mock14charID"
24
  },
25
  "upi_credentials": {
26
    "MPIN": "{\"type\":\"PIN\",\"subType\":\"MPIN\",\"data\":{\"encryptedBase64String\":\"encrypted_string\",\"code\":\"NPCI\"}}",
27
    "ARQC": "{\"type\":\"ARQC\",\"subType\":\"initial\",\"data\":{\"encryptedBase64String\":\"encrypted_string\",\"code\":\"NPCI-LITE\"}}"
28
  },
29
  "payees": [
30
    {
31
      "fundsource_lite_id": "lite_id"
32
    }
33
  ]
34
}'

Success

1
{
2
  "entity": "upi.payment",
3
  "upi_transaction_id": "RZPc2ed455b797e4add8392110cfc528acc",
4
  "reference_id": "ord_somfv432nsa",
5
  "upi_customer_reference_number": "804813039157",
6
  "upi_reference_url": "https://www.test.com",
7
  "upi_reference_category": "00",
8
  "upi_initiation_mode": "00",
9
  "upi_purpose_code": "42",
10
  "currency": "INR",
11
  "amount": 100,
12
  "type": "pay",
13
  "description": "flight tickets",
14
  "payer": {
15
    "vpa": "gaurav.kumar@exampleupi",
16
    "fundsource": {
17
      "ifsc": "AXIS0000058",
18
      "masked_account_number": "XXXXXXXXXXX3000"
19
    },
20
    "name": "Gaurav Kumar",
21
    "mcc": "0000",
22
    "upi_response_code": "00",
23
    "upi_reversal_response_code": "00"
24
  },
25
  "payees": [
26
    {
27
      "fundsource_lite": {
28
        "id": "lite_id",
29
        "upi_lite_reference_number": "1234567890",
30
        "upi_lite_credentials": {
31
          "ARPC": "string"
32
        }
33
      },
34
      "name": "Gaurav Kumar",
35
      "mcc": "0000",
36
      "response_code": "00",
37
      "reversal_response_code": "00"
38
    }
39
  ],
40
  "status": "created",
41
  "created_at": "1653915355",
42
  "updated_at": "1691097057"
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.

upi_purpose_code
enum

The 2-digit code defined by NPCI present in the intent URL or QR codes. Possible values:

  • 01: SEBI
  • 02: AMC
  • 03: Travel
  • 04: Hospitality
  • 05: Hospital
  • 06: Telecom
  • 07: Insurance
  • 08: Education
  • 09: Gifting
  • 10: BBPS
  • 11: Global UPI
  • 12: Metro ATM QR
  • 13: Non-metro ATM QR
  • 14: Standing Instruction
  • 15: Corporate disbursement

purpose

*

string

The purpose of the payout.

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 RM 100.00, enter 10000

type

*

string

Type of transaction. Should be pay.

description
string

Description of the transaction.

payer

*

string

Payer details.

Show child parameters (2)

upi_credentials

*

object

MPIN and ARQC encrypted credentials.

payees

*

string

Payee details.

Show child parameters (1)

Response Parameters
entity
string

Name of entity. Here it is, upi.payment.

upi_transaction_id
string

UPI transaction id generated.

reference_id
string

Merchant reference id.

upi_customer_reference_number
string

Customer Reference number at NPCI.

upi_reference_url
string

URL for the payment reference.

upi_reference_category
string

UPI Reference Category Code.

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.

upi_purpose_code
enum

The 2-digit code defined by NPCI present in the intent URL or QR codes. Possible values:

  • 01: SEBI
  • 02: AMC
  • 03: Travel
  • 04: Hospitality
  • 05: Hospital
  • 06: Telecom
  • 07: Insurance
  • 08: Education
  • 09: Gifting
  • 10: BBPS
  • 11: Global UPI
  • 12: Metro ATM QR
  • 13: Non-metro ATM QR
  • 14: Standing Instruction
  • 15: Corporate disbursement

currency
string

Currency for transaction (INR).

amount
string

Transaction amount in paisa.

type
string

Transaction type.

description
string

Payment description.

payer
object

Payer details.

Show child parameters (2)

payees
array

List of payee objects.

Show child parameters (4)

status
string

Transaction status. Possible values:

  • created
  • pending
  • success
  • failed

created_at
integer

UNIX timestamp at which the payment was created.

updated_at
integer

UNIX timestamp at which the payment was updated.

Top-up Fundsource Lite

POST
/v1/upi/tpap/payments/pay

Click to copy

Use this endpoint to add balance to Fundsource Lite 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.

upi_purpose_code
enum

The 2-digit code defined by NPCI present in the intent URL or QR codes. Possible values:

  • 01: SEBI
  • 02: AMC
  • 03: Travel
  • 04: Hospitality
  • 05: Hospital
  • 06: Telecom
  • 07: Insurance
  • 08: Education
  • 09: Gifting
  • 10: BBPS
  • 11: Global UPI
  • 12: Metro ATM QR
  • 13: Non-metro ATM QR
  • 14: Standing Instruction
  • 15: Corporate disbursement

purpose

*

string

The purpose of the payout.

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 RM 100.00, enter 10000

type

*

string

Type of transaction. Should be pay.

description
string

Description of the transaction.

payer

*

string

Payer details.

Show child parameters (2)

upi_credentials

*

object

MPIN and ARQC encrypted credentials.

payees

*

string

Payee details.

Show child parameters (1)

Response Parameters
entity
string

Name of entity. Here it is, upi.payment.

upi_transaction_id
string

UPI transaction id generated.

reference_id
string

Merchant reference id.

upi_customer_reference_number
string

Customer Reference number at NPCI.

upi_reference_url
string

URL for the payment reference.

upi_reference_category
string

UPI Reference Category Code.

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.

upi_purpose_code
enum

The 2-digit code defined by NPCI present in the intent URL or QR codes. Possible values:

  • 01: SEBI
  • 02: AMC
  • 03: Travel
  • 04: Hospitality
  • 05: Hospital
  • 06: Telecom
  • 07: Insurance
  • 08: Education
  • 09: Gifting
  • 10: BBPS
  • 11: Global UPI
  • 12: Metro ATM QR
  • 13: Non-metro ATM QR
  • 14: Standing Instruction
  • 15: Corporate disbursement

currency
string

Currency for transaction (INR).

amount
string

Transaction amount in paisa.

type
string

Transaction type.

description
string

Payment description.

payer
object

Payer details.

Show child parameters (2)

payees
array

List of payee objects.

Show child parameters (4)

status
string

Transaction status. Possible values:

  • created
  • pending
  • success
  • failed

created_at
integer

UNIX timestamp at which the payment was created.

updated_at
integer

UNIX timestamp at which the payment was updated.

Curl

1
curl -X POST 'https://api.rzp.<bank>.com/v1/upi/tpap/payments/pay' \
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": "QR Code",
11
  "upi_purpose_code": "42",
12
  "purpose": "UPI Lite Top Up",
13
  "device": {
14
    "geocode": "12.9667,77.5667",
15
    "ip": "198.1.1.1"
16
  },
17
  "currency": "INR",
18
  "amount": 100,
19
  "type": "pay",
20
  "description": "Upi-lite registration",
21
  "payer": {
22
    "vpa": "9560137963.stage@rzp",
23
    "fundsource_id": "fs_Mock14charID"
24
  },
25
  "upi_credentials": {
26
    "MPIN": "{\"type\":\"PIN\",\"subType\":\"MPIN\",\"data\":{\"encryptedBase64String\":\"encrypted_string\",\"code\":\"NPCI\"}}",
27
    "ARQC": "{\"type\":\"ARQC\",\"subType\":\"initial\",\"data\":{\"encryptedBase64String\":\"encrypted_string\",\"code\":\"NPCI-LITE\"}}"
28
  },
29
  "payees": [
30
    {
31
      "fundsource_lite_id": "lite_id"
32
    }
33
  ]
34
}'

Success

1
{
2
  "entity": "upi.payment",
3
  "upi_transaction_id": "RZPc2ed455b797e4add8392110cfc528acc",
4
  "reference_id": "ord_somfv432nsa",
5
  "upi_customer_reference_number": "804813039157",
6
  "upi_reference_url": "https://www.test.com",
7
  "upi_reference_category": "00",
8
  "upi_initiation_mode": "00",
9
  "upi_purpose_code": "42",
10
  "currency": "INR",
11
  "amount": 100,
12
  "type": "pay",
13
  "description": "flight tickets",
14
  "payer": {
15
    "vpa": "gaurav.kumar@exampleupi",
16
    "fundsource": {
17
      "ifsc": "AXIS0000058",
18
      "masked_account_number": "XXXXXXXXXXX3000"
19
    },
20
    "name": "Gaurav Kumar",
21
    "mcc": "0000",
22
    "upi_response_code": "00",
23
    "upi_reversal_response_code": "00"
24
  },
25
  "payees": [
26
    {
27
      "fundsource_lite": {
28
        "id": "lite_id",
29
        "upi_lite_reference_number": "1234567890",
30
        "upi_lite_credentials": {
31
          "ARPC": "string"
32
        }
33
      },
34
      "name": "Gaurav Kumar",
35
      "mcc": "0000",
36
      "response_code": "00",
37
      "reversal_response_code": "00"
38
    }
39
  ],
40
  "status": "created",
41
  "created_at": "1653915355",
42
  "updated_at": "1691097057"
43
}