---
page_source: https://docs.juspay.io/upi-inapp/android/headless-process-payloads/list-complaint
page_title: List Complaint
---


## List Complaint



This API can be used to list all complaints.


###   Process Parameters



## Request Payload
- **RequestId**:
  - Description: Unique uuid-v4 string
  - Value: Example: abcd-12345-abcd-12345
  - Tags: String, Mandatory
- **Service**:
  - Description: Value: in.juspay.hyperapi
  - Tags: String, Mandatory
- **Payload**:
  - Description: Parameters required to call Hyper SDK API
  - Value:
    - **Action**:
      - Description: Operation to be performed in the SDK
      - Value: upiListPendingComplaints
      - Tags: String, Mandatory
    - **Limit**:
      - Description: Maximum number of rows to be returned.
      - Value: eg. 100
      - Tags: String, Mandatory
    - **Offset**:
      - Description: Offset for complaints to be returned.
      - Value: 0
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - Tags: String, Mandatory
    - **SignaturePayload**:
      - Description: Signature payload is a stringified JSON of the details mentioned in the below table.
      - Value:
        - **Merchant_id**:
          - Description: Unique identifier associated with an account created by juspay. Ex: stock
          - Value: stock
          - Tags: String, Mandatory
        - **Customer_id**:
          - Description: Any unique reference associated with your customer.
          - Tags: String, Mandatory
        - **Timestamp**:
          - Description: Time when request is created in milliseconds.
          - Tags: String, Mandatory
      - Tags: String, Mandatory
    - **Signature**:
      - Description: Signature generated for the signaturePayload .
      - Tags: String, Mandatory
    - **UdfParameters**:
      - Description: Stringified json for udf parameters
      - Tags: String, Optional
  - Tags: JSON, Mandatory


## Response Payload
- **RequestId**:
  - Description: Unique uuid-v4 string
  - Value: Example: abcd-12345-abcd-12345
  - Tags: String
- **Service**:
  - Description: Value: in.juspay.hyperapi
  - Tags: String
- **Payload**:
  - Description: Response Parameters
  - Value:
    - **Action**:
      - Description: Operation performed in the SDK
      - Value: upiListPendingComplaints
      - Tags: String, Mandatory
    - **Status**:
      - Description: Status of the API call.
      - 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
    - **ComplaintsList**:
      - Description: Array of ListPendingComplaintPayload
      - Value:
        - **PayerVpa**:
          - Description: Payer Vpa
          - Tags: String, Mandatory
        - **PayeeVpa**:
          - Description: Payee Vpa
          - Tags: String, Mandatory
        - **OrgTxnStatus**:
          - Description: Original Transaction Status
          - Tags: String, Mandatory
        - **MerchantCustomerId**:
          - Description: Merchant generated unique profile id for customer as passed in the request
          - Tags: String, Optional
        - **CustomerMobileNumber**:
          - Description: masked phone number of the customer
          - Value: <customer mobile number>
          - Tags: String, Optional
        - **TransactionUpiRequestId**:
          - Description: Unique Transaction Request id on which status check is required.
          - Tags: String, Mandatory
        - **UpiRequestId**:
          - Description: Unique request id for upi transaction
          - Tags: String, Mandatory
        - **Crn**:
          - Description: Complaint reference number returned by NPCI
          - Value: eg. 302570532
          - Tags: String, Optional
        - **OrgTxnDate**:
          - Description: Original Transaction Date
          - Tags: String, Mandatory
        - **ComplaintDate**:
          - Description: Date of complaint
          - Tags: String, Mandatory
        - **Status**:
          - Description: Current Status of the transaction
          - Tags: String, Mandatory
        - **Remarks**:
          - Description: Remarks or reason for complaint
          - Tags: String, Mandatory
        - **ReqAdjAmount**:
          - Description: Amount of transaction sent in request
          - Value: 100.00
          - Tags: String, Mandatory
        - **ReqAdjCode**:
          - Description: Reason code for complaint sent in request
          - Value: 1082
          - Tags: String, Mandatory
        - **ReqAdjFlag**:
          - Description: Reason flag for complaint sent in request
          - Value: eg. PBRB
          - Tags: String, Mandatory
      - Tags: Array of JSON, Mandatory
    - **MerchantId**:
      - Description: Unique id for the merchant as passed in request
      - Tags: String, Mandatory
    - **MerchantChannelId**:
      - Description: Unique id for the merchant channel as passed in request
      - Tags: String, Mandatory
    - **OtherInfo**:
      - Description: As passed in request
      - Tags: String, Optional
  - Tags: JSON
- **Error**:
  - Description: Possible values :- true/false
  - Tags: Boolean
- **ErrorMessage**:
  - Description: Error Message
  - Tags: String
- **ErrorCode**:
  - Description: Error Code
  - Tags: String
- **Event**:
  - Description: Value: process_result
  - Tags: String





#### Code Snippets: -

#### Java Code Snippet:

```java
{
  "service": "in.juspay.hyperapi",
  "requestId": "095fa47e-b528-457d-8310-faece4c37814",
  "payload": {
    "action": "upiListPendingComplaints",
    "limit": 100,
    "offset": 0,
    "signature": "<signature>",
    "signaturePayload": "<signaturePayload>",
    "merchantKeyId": "1234"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "XXXXXXXX",
  "timestamp": "1641533238616"
}
```

#### Kotlin Code Snippet:

```kotlin
{
  "service": "in.juspay.hyperapi",
  "requestId": "095fa47e-b528-457d-8310-faece4c37814",
  "payload": {
    "action": "upiListPendingComplaints",
    "limit": 100,
    "offset": 0,
    "signature": "<signature>",
    "signaturePayload": "<signaturePayload>",
    "merchantKeyId": "1234"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "XXXXXXXX",
  "timestamp": "1641533238616"
}
```


## Sample Code Snippets:
### Request snippets:

#### Request Code Snippet:

```request
{
  "service": "in.juspay.hyperapi",
  "requestId": "095fa47e-b528-457d-8310-faece4c37814",
  "payload": {
    "action": "upiListPendingComplaints",
    "limit": 100,
    "offset": 0,
    "signature": "<signature>",
    "signaturePayload": "<signaturePayload>",
    "merchantKeyId": "1234"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "XXXXXXXX",
  "timestamp": "1641533238616"
}
```

### Response snippets:

#### Response:
```plaintext
{
  "service": "in.juspay.hyperapi",
  "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677",
  "payload": {
    "action": "upiListPendingComplaints",
    "status": "SUCCESS",
    "responseCode": "SUCCESS",
    "responseMessage": "SUCCESS",
    "merchantId": "stock",
    "merchantChannelId": "stockAPP",
    "complaintList": [{
      "payerVpa": "123454306@1234",
      "payeeVpa": "83746598743@2312",
      "orgTxnStatus": "PENDING",
      "merchantCustomerId": "test-merchantcustomer-1",
      "customerMobileNumber": "919988776655",
      "transactionUpiRequestId": "3764723469",
      "upiRequestId": "72832032893287",
      "crn": "941451534851394",
      "orgTxnDate": "16683984398",
      "complaintDate": "16683984398",
      "status": "SUCCESS",
      "remarks": "UPI",
      "reqAdjAmount": "0.50",
      "reqAdjFlag": "PBRB",
      "reqAdjCode": "U010",
    }]
  },
  "event": "process_result",
  "errorMessage": "",
  "errorCode": "",
  "error": false
}
```