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

Complaints Flow

Fetch Complaints

API Test Keys

Fetch Complaints

GET
/v1/complaints?upi_transaction_id=1232341412& refresh=true&limit=4&offset=10&status=success

Click to copy

Use this endpoint to fetch the status of a specific complaint or retrieve a list of complaints.

Is this page helpful?

Curl

1
curl -X GET 'https://api.rzp.<bank>.com/v1/complaints?upi_transaction_id=1232341412&refresh=true&limit=4&offset=10&status=success' \
2
-u [YOUR_KEY_ID]:[YOUR_SECRET] \
3
-H "Content-type: application/json" \
4
-H "Authorization: Bearer <token>" \
5
-H "x-device-fingerprint: <device_fingerprint>" \
6
-H "x-device-fingerprint-timestamp: 1496918882000" \
7
-H "x-customer-reference: customer-id-from-customer" \

Success

Failure

1
{
2
  "entity": "collection",
3
  "count": 1,
4
  "items": [
5
    {
6
      "entity": "upi.complaint",
7
      "reference_id": "123214121",
8
      "upi_reference_id": "123214121",
9
      "request_adjustment_amount": 500,
10
      "request_adjustment_code": "U010",
11
      "request_adjustment_flag": "PBRB",
12
      "upi_customer_reference_number": "CRN987654321",
13
      "adjustment_amount": 500,
14
      "adjustment_code": "102",
15
      "adjustment_flag": "PR2C",
16
      "payee": {
17
        "vpa": "acme.corp@rzp",
18
        "name": "AcmeCorp Pvt. Ltd."
19
      },
20
      "status": "success",
21
      "description": "Complaint for failed transaction under review",
22
      "upi_transaction_id": "1232341412",
23
      "upi_original_transaction_id": "1232341412",
24
      "created_at": 1705411200
25
    }
26
  ]
27
}
Query Parameters
upi_transaction_id
string

Fetch the complaint status for the specific transaction id.

Watch Out!

This value should be alphanumeric and a maximum of 35 characters are allowed. The value should start with a prefix given by NPCI to Switch.

refresh
boolean

Determines whether to fetch payment status from NPCI. Possible values:

  • true: If set to true, fetch payment status from NPCI.
  • false (default): If set to false, return payment from the local database.

limit
integer

Maximum number of records to return. Used for pagination.

offset
integer

Offset value for pagination.

status
string

The status of the complaint. Possible values:

  • initiated
  • success
  • failure

Response Parameters
entity
string

The entity type. Here, it is collection.

count
integer

Indicates the number of items in the entity type.

items
object

The complaint details.

Show child parameters (16)

Fetch Complaints

GET
/v1/complaints?upi_transaction_id=1232341412& refresh=true&limit=4&offset=10&status=success

Click to copy

Use this endpoint to fetch the status of a specific complaint or retrieve a list of complaints.

Is this page helpful?

Query Parameters
upi_transaction_id
string

Fetch the complaint status for the specific transaction id.

Watch Out!

This value should be alphanumeric and a maximum of 35 characters are allowed. The value should start with a prefix given by NPCI to Switch.

refresh
boolean

Determines whether to fetch payment status from NPCI. Possible values:

  • true: If set to true, fetch payment status from NPCI.
  • false (default): If set to false, return payment from the local database.

limit
integer

Maximum number of records to return. Used for pagination.

offset
integer

Offset value for pagination.

status
string

The status of the complaint. Possible values:

  • initiated
  • success
  • failure

Response Parameters
entity
string

The entity type. Here, it is collection.

count
integer

Indicates the number of items in the entity type.

items
object

The complaint details.

Show child parameters (16)

Curl

1
curl -X GET 'https://api.rzp.<bank>.com/v1/complaints?upi_transaction_id=1232341412&refresh=true&limit=4&offset=10&status=success' \
2
-u [YOUR_KEY_ID]:[YOUR_SECRET] \
3
-H "Content-type: application/json" \
4
-H "Authorization: Bearer <token>" \
5
-H "x-device-fingerprint: <device_fingerprint>" \
6
-H "x-device-fingerprint-timestamp: 1496918882000" \
7
-H "x-customer-reference: customer-id-from-customer" \

Success

Failure

1
{
2
  "entity": "collection",
3
  "count": 1,
4
  "items": [
5
    {
6
      "entity": "upi.complaint",
7
      "reference_id": "123214121",
8
      "upi_reference_id": "123214121",
9
      "request_adjustment_amount": 500,
10
      "request_adjustment_code": "U010",
11
      "request_adjustment_flag": "PBRB",
12
      "upi_customer_reference_number": "CRN987654321",
13
      "adjustment_amount": 500,
14
      "adjustment_code": "102",
15
      "adjustment_flag": "PR2C",
16
      "payee": {
17
        "vpa": "acme.corp@rzp",
18
        "name": "AcmeCorp Pvt. Ltd."
19
      },
20
      "status": "success",
21
      "description": "Complaint for failed transaction under review",
22
      "upi_transaction_id": "1232341412",
23
      "upi_original_transaction_id": "1232341412",
24
      "created_at": 1705411200
25
    }
26
  ]
27
}