Collect a Payment

UPI allows a customer or a payee to request a payment from another person or entity. This API is the same as the make payments API. The type of payment changes to collect and no credentials are required to be captured by the customer requesting the payment. Use this endpoint to collect a payment.

Request

Curl

curl -X POST 'api.rzp..com/v1/payments/collect' \
     -u [YOUR_KEY_ID]:[YOUR_SECRET] \
-H "Content-type: application/json" \
-H "x-device-fingerprint: " \
-H "x-device-fingerprint-timestamp: 1496918882000" \
-H "x-customer-reference: customer-id-from-customer" \
-d '{
  "reference_id": "RSKwpINfSkdEvtdxf",
  "upi_initiation_mode": "00",
  "upi_purpose_code": "00",
  "upi_reference_url": "https://www.test.com",
  "upi_reference_category": "00",
  "device": {
    "geocode": "1234.1213",
    "ip": "198.1.1.1"
  },
  "currency": "INR",
  "amount": 100,
  "description": "UPI transaction",
  "payer": {
    "vpa": "7262093972.stage@rzp"
  },
  "payees": [
    {
      "vpa": "9560137963.stage@rzp"
    }
  ],
  "expire_at": 150603365
}'

Response

{
  "entity":"upi.payment",
  "upi_transaction_id":"RZPc2ed455b797e4add8392110cfc528acc",
  "reference_id":"ord_somfv432nsa",
  "upi_customer_reference_number":"804813039157",
  "upi_reference_url":"https://www.test.com",
  "upi_reference_category":"00",
  "upi_initiation_mode":"00",
  "upi_purpose_code":"00",
  "currency":"INR",
  "amount":10024,
  "type":"pay | collect",
  "description":"flight tickets",
  "payer":{
    "vpa":"gaurav.kumar@exampleupi",
    "fundsource":{
      "ifsc":"AXIS0000058",
      "masked_account_number":"XXXXXXXXXXX3000"
    },
    "name":"Gaurav Kumar",
    "mcc":"0000",
    "upi_response_code":"00",
    "upi_reversal_response_code":"string"
  },
  "payees":[
    {
      "vpa":"acme.corp@rzp",
      "fundsource":{
        "ifsc":"HDFC0000058",
        "masked_account_number":"XXXXXXXXXXX6000"
      },
      "name":"AcmeCorp Pvt. Ltd.",
      "mcc":"6765",
      "upi_response_code":"00",
      "upi_reversal_response_code":"string"
    }
  ],
  "status":"initiated| success | failed",
  "created_at":"1722317078",
  "expire_at":"1722317078"
}

Parameters

reference_id optional : string Indicates the transaction ID used by merchants for their reference. It is used at the business level and not in the UPI ecosystem. This value should be alphanumeric and between 1 and 35 characters. upi_initiation_mode optional : enum Indicates the 2-digit code defined by NPCI present in the intent URL or QR codes. 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 optional : 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

upi_reference_url optional : string Indicates a URL that, upon clicking, provides the customer with further transaction details such as bill details, bill copy, order copy, ticket details, and so on. When used, this URL should be related to the particular transaction and not be used to send unsolicited information irrelevant to the transaction. upi_reference_category mandatory : string The 2-digit code defined by NPCI present in the intent URL or QR codes. Possible values:

00: NULL
01: Advertisement
02: Invoice

device mandatory : object The device details. geocode : string The location coordinates of the device. ip : string The IP address of the device. currency mandatory : string The currency of the amount. Here, it is INR. amount mandatory : integer The amount in paise. description optional : string The description of the payment. payer mandatory : object The payer details. vpa : string The VPA of the payer. payees mandatory : array The payee details. vpa : string The VPA of the payee.

Parameters

entity : string The entity type. Here, it is upi.payment. reference_id : string Indicates the transaction ID used by merchants for their reference. It is used at the business level and not in the UPI ecosystem. This value should be alphanumeric and between 1 and 35 characters. upi_reference_url : string Indicates a URL that, upon clicking, provides the customer with further transaction details such as bill details, bill copy, order copy, ticket details, and so on. When used, this URL should be related to the particular transaction and not be used to send unsolicited information irrelevant to the transaction. upi_reference_category : string The 2-digit code defined by NPCI present in the intent URL or QR codes. Possible values:

00: NULL
01: Advertisement
02: Invoice

upi_initiation_mode : enum Indicates the 2-digit code defined by NPCI present in the intent URL or QR codes. 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

device : object The device details. geocode : string The location coordinates of the device. ip : string The IP address of the device. currency : string The currency of the amount. Here, it is INR. amount : integer The amount in paise. type : string The type of the payment. Possible values:

pay
collect

description : string The description of the payment. payer : object The payer details. vpa : string The VPA of the payer. payees : object The payee details. vpa : string The VPA of the payee. expire_at : integer The UNIX timestamp of the collect request.

Introduction

API Guides

Core Resources API

Products API

Additional Resources

Payments

QR Codes

RazorpayX

Partners

Collect a Payment

Request

Response

Parameters

Parameters

​Request

​Response

​Parameters

​Parameters

Request

Response

Parameters

Parameters