Raise a Complaint

Register a complaint related to a UPI payment transaction.

POST /v1/complaints/raise

Curl

curl -X POST 'https://api.rzp.<bank>.com/v1/complaints/raise' \
-u [YOUR_KEY_id]:[YOUR_SECRET] \
-H "Content-type: application/json" \
-H "Authorization: Bearer <token>" \
-H "x-device-fingerprint: <device_fingerprint>" \
-H "x-device-fingerprint-timestamp: 1496918882000" \
-H "x-customer-reference: customer-id-from-customer" \
-d '{
  "reference_id": "123214121",
  "upi_transaction_id": "1234567890",
  "upi_original_transaction_id": "1231312321412",
  "upi_initiation_mode": "00",
  "upi_purpose_code": "01",
  "upi_reference_category": "00",
  "upi_reference_url": "https://www.abcxyz.com/",
  "request_adjustment_amount": "500",
  "request_adjustment_code": "U010",
  "request_adjustment_flag": "PBRB",
  "description": "Amount not credited"
}'

Success

{
  "entity": "upi.complaint",
  "reference_id": "123214121",
  "upi_reference_id": "123214121",
  "upi_transaction_id": "1234567890",
  "upi_response_code": "01",
  "upi_customer_reference_number": "123214121",
  "payee": {
    "vpa": "acme.corp@rzp",
    "name": "AcmeCorp Pvt. Ltd."
  },
  "description": "Your Complaint is Raised",
  "status": "initiated",
  "request_adjustment_amount": "500",
  "request_adjustment_code": "U010",
  "request_adjustment_flag": "PBRB"
}

Available in🇮🇳 India

Use this endpoint to register a complaint for a failed or unsatisfactory UPI transaction.

Curl

curl -X POST 'https://api.rzp.<bank>.com/v1/complaints/raise' \
-u [YOUR_KEY_id]:[YOUR_SECRET] \
-H "Content-type: application/json" \
-H "Authorization: Bearer <token>" \
-H "x-device-fingerprint: <device_fingerprint>" \
-H "x-device-fingerprint-timestamp: 1496918882000" \
-H "x-customer-reference: customer-id-from-customer" \
-d '{
  "reference_id": "123214121",
  "upi_transaction_id": "1234567890",
  "upi_original_transaction_id": "1231312321412",
  "upi_initiation_mode": "00",
  "upi_purpose_code": "01",
  "upi_reference_category": "00",
  "upi_reference_url": "https://www.abcxyz.com/",
  "request_adjustment_amount": "500",
  "request_adjustment_code": "U010",
  "request_adjustment_flag": "PBRB",
  "description": "Amount not credited"
}'

Success

{
  "entity": "upi.complaint",
  "reference_id": "123214121",
  "upi_reference_id": "123214121",
  "upi_transaction_id": "1234567890",
  "upi_response_code": "01",
  "upi_customer_reference_number": "123214121",
  "payee": {
    "vpa": "acme.corp@rzp",
    "name": "AcmeCorp Pvt. Ltd."
  },
  "description": "Your Complaint is Raised",
  "status": "initiated",
  "request_adjustment_amount": "500",
  "request_adjustment_code": "U010",
  "request_adjustment_flag": "PBRB"
}

Request Parameters

reference_id · string · required

Unique id generated by the business for the complaint.

upi_transaction_id · string · required

Unique transaction id on which the complaint is raised.

upi_original_transaction_id · string · required

Original UPI transaction id used at the time of payment.

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

upi_reference_category · string · required

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

• 00: NULL
• 01: Advertisement
• 02: Invoice

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.

request_adjustment_amount · integer

Complaint amount in paisa.

request_adjustment_code · string

NPCI-defined reason code for complaint.

request_adjustment_flag · string

NPCI-defined flag associated with the complaint reason.

description · string

Description for the complaint.

Response Parameters

entity · string

Entity type. Here it is upi.complaint.

reference_id · string

Business-generated complaint reference id.

upi_reference_id · string

Identifier returned by Razorpay for the complaint.

upi_transaction_id · string

UPI transaction id related to the complaint.

upi_response_code · string

Code returned by NPCI indicating complaint status.

upi_customer_reference_number · string

Complaint id shared by NPCI.

payee · object

The payee details.

vpa · string

The VPA of the payee.

name · string

The name of the payee.

description · string

Acknowledgement or status description.

status · string

Indicates the complaint status. Possible values:

• initiated
• active
• completed
• paused
• failed

request_adjustment_amount · integer

The adjustment amount for the complaint, in paise.

request_adjustment_code · string

Code representing complaint reason from NPCI.

request_adjustment_flag · string

Flag associated with the complaint reason from NPCI.