Adding complaint by txnId

Api used to raise complaint against a transaction

Endpoint

Request:POST /couapp/complaints

Request Parameters

The various parameters are explained below:

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

[ROOT] (No parent property / element)

complaintDescription

M

String

Complaint description that the user enters

complaintDisposition

M

String

Complaint disposition

complaintType

M

String

The type of complaint

txnId

O

UUID

Transaction id for which the complaint is raised against

clientReqId

O

String

Client req id for which the complaint is raised against

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

txnNpciId

M

String

Transaction id for which the complaint is raised agains

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

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

String

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 RequestExample

{
"complaintDescription": "Testing",
"complaintDisposition": "Transaction Successful, account nAot updated", 
"complaintType": "transaction",
"txnId": "6f5c45bb-03f7-46c2-88a8-7c1ac9f83714", 
"tenantId": "FE41"
}

Json Formatted Response Example

{
"complaints": { 
"complaintDescr": "Testing",
"complaintDispos": "Transaction Successful, account not updated", 
"complaintId": "5383c03b-28e7-4d9c-ac4c-3d19e6ec9e61", 
"complaintRaisedFrom": "agent",
"complaintType": "npciComplaint", 
"createdEpochDate": 1682315434, 
"creationDate": "2023-04-24T11:20:34.937317Z", 
"modifiedDate": "2023-04-24T11:20:35.105937Z",
"modifiedEpochDate": 1682315435,
"refId": "wpTw4UDGDS23mSPYK7vmub2X8uX31141120", 
"status": "COMPLAINT_REQUEST_SUCCESS",
"tenantId": "FE41",
"txnId": "6f5c45bb-03f7-46c2-88a8-7c1ac9f83714", 
"txnNpciId": "FE413102sViuzlGJFbCy",
"userId": "FE41FE42BNK519012345", 
"agentId": "FE41FE42BNK519012345"
},
"generalResp": {
"message": "Complaint raising requested", 
"remarks": "",
"status": "success", 
"statusCode": "200"
}
}

Last updated