BBPS
  • BBPS
    • BBPS Agent Integration
      • Broad examples of bill payments
      • How a bill is presented
      • FETCH AND PAY
        • Bill fetch api
        • Bill Fetch by bill id api
        • Bill Fetch by client request id api
      • VALIDATE AND PAY
        • Bill validate api
        • Bill Validation response by client request id api
        • Bill validation response by bill id api
      • QUICK PAY
      • COMPLAINT RAISING
      • AGENT APPLICATION
      • BBPS Master Data API
        • List Billers API
        • Billers By ID API
        • Categories Master Data API
        • Contact Master Data API
        • Customer Parameters API
        • Customer Parameters API
        • Customer Parameters Groups API
        • Disposition API
        • Initiating Channel API
      • BBPS Agent API
        • Bill Fetch by bill id
        • Bill Fetch by Client Request ID API
        • Get all Plan categories
        • Get all Plans
        • Bill Validate API
        • Bill Validation response by Client Request ID API
        • Bill validation response by bill id
        • Bill Payment API
        • Transaction Status txnId API
        • Transaction Status ClientReqId API
        • Adding complaint by txnId
        • View Complaints by id
        • View All Complaints
        • Txn Status Check API (401)
        • View Complaints History by id
        • Close Complaint
        • Reopen Complaint
        • Complaint Status
      • Get all Plan categories
      • Get all Plans
    • BBPS Biller Integration
      • BBPS API Workflow
      • BBPS API List
        • BILL FETCH API
        • Bill Fetch Response Endpoint
        • BILL PAY API
          • BillPayment Response Endpoint
          • Payment Notification API
          • Payment Status API
        • BILL VALIDATE API
          • BillValidation Response Endpoint
        • STATUS 402 API
          • TxnStatusResponse Endpoint
      • Bill Fetch by bill id
Powered by GitBook
On this page

Was this helpful?

  1. BBPS
  2. BBPS Agent Integration
  3. BBPS Agent API

View All Complaints

Api used to view all complaints

Endpoint

Request:GET /couapp/complaints/all?pageNo=0&pageSize=5&statusType= COMPLAINT_OPEN_SUCCESS

Request Parameters

The various parameters are explained below:

Parent Property/Element
Property/Element Name
Mandatory
Data Type
Description

[ROOT] (No parent property / element)

statusType

M

String

Status of the complaint, possible values are - COMPLAINT_OPEN_SUCCESS COMPLAINT_OPEN_FAILED COMPLAINT_CLOSURE_SUCCESS COMPLAINT_CLOSURE_FAILED COMPLAINT_REOPEN_SUCCESS COMPLAINT_REOPEN_FAILED COMPLAINT_STATUS_UPDATE COMPLAINT_REQUEST_INITIATED COMPLAINT_REQUEST_SUCCESS COMPLAINT_REQUEST_FAILED COMPLAINT_CLOSURE_REQUEST_SUCCE SS COMPLAINT_CLOSURE_REQUEST_FAILE D COMPLAINT_REOPEN_REQUEST_SUCCES S COMPLAINT_REOPEN_REQUEST_FAILED COMPLAINT_REASSIGN_REQUEST_SUCC ESS- COMPLAINT_REASSIGN_REQUEST_FAILE D COMPLAINT_REASSIGN_SUCCESS COMPLAINT_REASSIGN_FAILED

page

C

Numeric

Page number for API Response Pagination

pagesize

C

Numeric

Page Size for API Response Pagination

Response Parameters

The various parameters are explained below:

Parent Property/Element
Property/Element Name
Mandatory
Data Type
Description

complaintsList

complaintId

M

UUID

Id for the complaint disposion

complaintDescr

M

String

Complaint description

complaintDispos

M

String

Complaint disposition

complaintType

M

String

Type of the complaint

txnId

M

String

Transaction id for which the complaint is raised agains

complaintStatus

M

String

Complaint Status from NPCI

assignedTo

M

String

To Whom the complaint is assigned

complaintNpciId

M

String

Npci id of the complaint

complaintRaisedFrom

M

String

Who raised the complaint

userId

M

String

User id of the one who raised the complaint

status

M

String

Status of the complaint

refId

M

String

Reference id

estimated_TAT

M

String

creationDate

M

String

ISO 8601 Timestamp for the Complaint Creation date

modifiedDate

M

String

ISO 8601 Timestamp for the Complaint Modification date

billerName

M

String

Biller Name

txnAmount

M

String

Txn Amount

superLevelEsc

M

String

Super Escalation (True/False)

openComplaint

M

String

Flag indicating whether complaint is already open or not (Y/N)

reopenComplaint

M

String

Flag indicating whether complaint is already reopened or not (Y/N)

remarks

M

String

Remarks

agentId

M

String

Agent ID

category

M

String

Category of the biller

createdEpochDate

M

Numeric

UNIX Epoch Timestamp for the Complaint Creation date

modifiedEpochDate

M

Numeric

UNIX Epoch Timestamp for the Complaint Modification date

generalResp

statusCode

M

Numeric

200- SUCCESS Other than 200-Failure

status

M

String

It is either “Success” or failure

message

M

String

Contains the reason message for failure / success

{
"complaintsList": [
{
"assignedTo": "",
"comment": "",
"complaintDescr": "Testing complaint",\
"complaintDispos": "Transaction Successful, account not updated", 
"complaintId": "2dfecc3c-9114-4094-9aa8-ff26f03a9bfd", 
"complaintNpciId": "FE4123109489834",
"complaintRaisedFrom": "agent", 
"complaintType": "npciComplaint", 
"createdEpochDate": 1681905485, 
"creationDate": "2023-04-19T17:28:05.508679Z",
"estimated_TAT": "",
"modifiedDate": "2023-04-24T10:07:51.756969Z",
"modifiedEpochDate": 1682311071,
"refId": "mqcXfZs2XMkRKQfpIwoSYQDnIr231091728", 
"status": "COMPLAINT_OPEN_SUCCESS",
"txnId": "24fe190c-42c9-4cb5-9d36-965839b0cb5f", 
"userId": "FE41FE42BNK519012345",
"category": "Education Fees",
"billerName": "Meerut Institute Of Technology test", 
"txnAmount": 50000,
"totalTxnAmount": 50000, 
"complaintStatus": "", 
"superLevelEsc": "",
"openComplaint": "", 
"reopenComplaint": "", 
"remarks": "",
"agentId": "FE41FE42BNK519012345"
}
],
"generalResp": {
"message": "Complaints retrieved successfully", 
"remarks": "",
"status": "success", 
"statusCode": "200"
},
"pageNo": 0,
"pageSize": 1,
"totalPages": 1,
"totalElements": 1
}

Status and its meaning :-

Open Complaint - COMPLAINT_OPEN_SUCCESS Failed Complaint - COMPLAINT_OPEN_FAILED Closed Complaint - COMPLAINT_CLOSURE_SUCCESS Closure Failed Complaint - COMPLAINT_CLOSURE_FAILED ReOpened Complaints - COMPLAINT_REOPEN_SUCCESS ReOpen Failed Complaints - COMPLAINT_REOPEN_FAILED Status Updated Complaints (508 Alert) - COMPLAINT_STATUS_UPDATE Complaint Request Initiated from Biller/Agent - COMPLAINT_REQUEST_INITIATED Complaint Requested from Biller/Agent - COMPLAINT_REQUEST_SUCCESS Failed Complaint Request from Biller/Agent - COMPLAINT_REQUEST_FAILED Successful Complaint Closure Request - COMPLAINT_CLOSURE_REQUEST_SUCCESS Failed Complaint Closure Request - COMPLAINT_CLOSURE_REQUEST_FAILED Successful Complaint Reopen Request - COMPLAINT_REOPEN_REQUEST_SUCCESS Failed Complaint Reopen Request - COMPLAINT_REOPEN_REQUEST_FAILED Successful Complaint Reassign request from COU - COMPLAINT_REASSIGN_REQUEST_SUCCESS Failed Complaint Reassign request from COU -COMPLAINT_REASSIGN_REQUEST_FAILED ReAssigned Complaints - COMPLAINT_REASSIGN_SUCCESS ReAssign Failed Complaints - COMPLAINT_REASSIGN_FAILED

PreviousView Complaints by idNextTxn Status Check API (401)

Last updated 1 year ago

Was this helpful?