Complaint Status

API for fetching latest status of the complaint from NPCI. The API can be invoked only if complaintType is npciComplaint.

Endpoint
Request: /couapp/complaints/status

Request Parameters

The various parameters are explained below:

Parent Property/Element	Property/Element Name	Mandatory	Data Type	Description
[ROOT] (No parent property / element)	tenantId	M	Alphanumeric	Fixed Length – 4
	complaintId	M	UUID	Complaint UUID

Response Parameters

The various parameters are explained below:

Parent Property/Element	Property/Element Name	Mandatory	Data Type	Description
complaints	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

Json Formatted Request Example

{
"complaintId" : "2dfecc3c-9114-4094-9aa8-ff26f03a9bfd", 
"tenantId" : "FE41"
}

Json Formatted Response Example

{
"complaints": { "assignedTo": "XYZ Bank",
"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",
"modifiedDate": "2023-04-19T17:28:10.001432Z",
"modifiedEpochDate": 1681905490,
"refId": "mqcXfZs2XMkRKQfpIwoSYQDnIr231091728", 
"status": "COMPLAINT_OPEN_SUCCESS",
"tenantId": "FE41",
"txnId": "24fe190c-42c9-4cb5-9d36-965839b0cb5f", 
"txnNpciId": "FE4131090DAI26Y0mAxl",
"userId": "FE41FE42BNK519012345", 
"agentId": "FE41FE42BNK519012345"
},
"generalResp": {
"message": "Successfully requested complaint status", 
"remarks": "",
"status": "success", 
"statusCode": "200"
}
}