View All Complaints
Last updated
Last updated
Api used to view all complaints
Endpoint |
---|
Request Parameters
The various parameters are explained below:
Parent Property/Element | Property/Element Name | Mandatory | Data Type | Description |
---|---|---|---|---|
The various parameters are explained below:
Parent Property/Element | Property/Element Name | Mandatory | Data Type | Description |
---|---|---|---|---|
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
Request:GET /couapp/complaints/all?pageNo=0&pageSize=5&statusType= COMPLAINT_OPEN_SUCCESS
[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
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