---
page_source: https://juspay.io/in/docs/upi-consumer-stack/docs/complaints-udir/complaint-status
page_title: Complaint Status
---

## API Version: default


# Complaint Status



This api will be used for checking the status of complaints raised on any transactions.

> **Note**
> 1. Transaction and Complaints Status check shall be allowed only after '3' mins from the time of respective txn.
> 2. Per day only 3 check status can be done to the NPCI UDIR system, after that PSP will pick the status from the database and that will be shared.
> 3. For the below request type = "TXNDISPUTE" will correspond to one of the subTypes of "reqComplaint" api where we specify whether we want the status for txn, dispute or both. Currently we don't serve other use cases. We have kept it as a field in request body for future api enhancements.

## Endpoints:
- Production: http://{{lhost}}/api/{uri}/merchants/complaints/status

## Request Type: 
POST

## Headers:

#### Content-Type:
`application/json`
- Value: application/json
- Tags: string, Required

#### x-merchant-id:
Will be shared while onboarding.
- Value: TEST
- Tags: string, Required

#### x-merchant-channel-id:
Will be shared while onboarding.
- Value: TESTAPP
- Tags: string, Required

#### Accept:
`application/json`
- Value: application/json
- Tags: string, Required

#### x-timestamp:
This is an epoch unix timestamp string. For example, `1496918882000`. It can be used by us to invalidate older requests.
- Value: 23456789012
- Tags: String, Required

#### x-merchant-signature:
This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.
- Value: janfajnskdfcxnkansdkcnakdnsckvnafkd
- Tags: string, Required
## Sample Code Snippets:
### Code Snippets:

#### Shell Code Snippet:

```shell
{"success":false,"message":"No Data found for the given path"}
```

### Sample Request and Response:

#### Request:
```json
{"success":false,"message":"No Data found for the given path"}
```

#### Response:
```json
{"success":false,"message":"No Data found for the given path"}
```

## Body Parameters:
### Parameters:

#### merchantCustomerId:
- Description: Merchant generated unique profile id for customer

**Constraint:** Alphanumeric string with dot(.). Maximum length is 256.
- Tags: String, Mandatory

#### originalTransactionUpiRequestId:
- Description: Original Transaction Unique id sent to UPI switch for the request

**Constraint:** 35 character alphanumeric. Should always start with merchant prefix provided.
- Tags: String, Mandatory

#### type:
- Description: Type of Complaint Status

Value- String `TXNDISPUTE`
- Tags: String, Mandatory

#### originalUpiRequestId:
- Description: Unique id sent to UPI switch for the request

**Constraint:** 35 character alphanumeric. Should always start with merchant prefix provided.
- Tags: String, Mandatory

#### udfParameters:
- Description: Stringified JSON for udf parameters
- Tags: String, Optional
## API Responses:
### 200:

#### status:
- Description: PSP status of the API

**Values** :  `SUCCESS | FAILURE`
- Value:  SUCCESS | FAILURE
- Tags: String, Mandatory

#### responseCode:
- Description: PSP response code for the API
- Tags: String, Mandatory

#### responseMessage:
- Description: PSP response message for the API
- Tags: String, Mandatory

#### payload:
- Value:
  - **MerchantChannelId**:
    - Description: Unique id for the merchant channel as passed in request headers
    - Tags: String, Mandatory
  - **GatewayResponseStatus**:
    - Description: Response status returned by gateway
      
      **Values:** `OPEN|CLOSED|``PENDING|FAILURE`
    - Tags: String, Mandatory
  - **MerchantId**:
    - Description: Unique id for the merchant as passed in request headers
    - Tags: String, Mandatory
  - **GatewayComplaintId**:
    - Description: Complaint id returned by gateway
    - Tags: String, Mandatory
  - **ReqAdjAmount**:
    - Description: Amount of the transaction sent to NPCI when complaint was raised
      
      **Constraint:** Amount in two decimals.
    - Tags: String, Mandatory
  - **GatewayResponseMessage**:
    - Description: Response message for code returned by gateway
    - Tags: String, Mandatory
  - **PayerVpa**:
    - Description: VPA of the customer to be used for payment
    - Tags: String, Mandatory
  - **MerchantRequestId**:
    - Description: Merchant generated id for the transaction
    - Tags: String, Mandatory
  - **GatewayResponseCode**:
    - Description: Response code returned by gateway
    - Tags: String, Mandatory
  - **GatewayReferenceId**:
    - Description: Reference id returned by the gateway
    - Tags: String, Mandatory
  - **ReqAdjCode**:
    - Description: Reason Code for complaint sent to NPCI when complaint was raised
    - Tags: String, Mandatory
  - **Crn**:
    - Description: Complaint reference number returned by NPCI
      
      **Constraint:** 14 to 16 characters alphanumeric.
    - Tags: String, Optional
  - **CustomerMobileNumber**:
    - Description: Customer mobile number as per device binding
      
      **Constraint:** 12 digits mobile number string
    - Tags: String, Mandatory
  - **PayeeVpa**:
    - Description: Vpa for customer who received the payment
    - Tags: String, Mandatory
  - **ReqAdjFlag**:
    - Description: Reason flag for complaint sent to NPCI when complaint was raised
    - Tags: String, Mandatory
  - **TransactionAmount**:
    - Description: The total amount for which original transaction was performed.
    - Tags: String, Mandatory
  - **MerchantCustomerId**:
    - Description: Merchant generated unique profile id for customer as passed in the request
    - Tags: String, Mandatory
- Tags: Json, Mandatory

#### udfParameters:
- Tags: Json String, Optional