Body
List Complaints
This Api will be used to get the list of all pending complaints on a particular merchant or merchantCustomer.
Request
Response
API Endpoints
Production Link
POST
http://{{lhost}}/api/{uri}/merchants/complaints/list
Headers
Content-Type
*
string
Required
application/json
x-merchant-id
*
string
Required
Will be shared while onboarding.
x-merchant-channel-id
*
string
Required
Will be shared while onboarding.
Accept
*
string
Required
application/json
x-timestamp
*
String
Required
This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.
x-merchant-signature
*
string
Required
This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.
Parameters
merchantCustomerId
String
Optional
Merchant generated unique profile id for customer
Constraint: Alphanumeric string with dot(.). Maximum length is 256.
startDate
*
String
Mandatory
Time from which complaint status list is required
Constraint: Date (2012/12/03) (YYYY/MM/DD)
limit
*
String
Mandatory
Maximum number of rows to be returned. Used for pagination
Constraint: Number > 0
offSet
*
String
Mandatory
Offset for rows to be returned. Used for pagination
Constraint: Number >= 0
udfParameters
Json String
Optional
Stringified JSON for udf parameters
endDate
String
Optional
Time till which complaint status List is required (can only be available for 6 months period as the txn would be archived after that)
Constarint: End date <= Current date
Status
Array of string
Optional
List of all possible values of complaint status. In case the list is empty then return all the complaints within the given time slot
Values: OPEN| CLOSED| PENDING| COMPLAINT RECEIVED| FAILURE.
200 : Success
Response Body
status
*
String
Mandatory
PSP status of the API
Values: SUCCESS | FAILURE
responseCode
*
String
Mandatory
PSP response code for the API
responseMessage
*
String
Mandatory
PSP response message for the API
payload
*
Json
Mandatory
merchantId
*
String
Mandatory
Unique id for the merchant as passed in request headers
merchantChannelId
*
String
Mandatory
Unique id for the merchant channel as passed in request headers
pendingComplaints
*
Array of Json
Mandatory
Array of pending complaints
payerVpa
*
String
Mandatory
VPA of the customer to be used for payment
payeeVpa
*
String
Mandatory
Vpa of the payee to whom money is being sent
orgTxnStatus
*
String
Mandatory
Status of Transaction
Values: SUCCESS, FAILURE
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer as passed in the request
customerMobileNumber
*
String
Mandatory
Customer mobile number as per device binding
Constraint: 12 digits mobile number string
originalUpiRequestId
*
String
Mandatory
Unique id of the transaction on which complaint is raised
Constraint: 35 character alphanumeric.
upiRequestId
*
String
Mandatory
Unique id of the complaint
Constraint: 35 character alphanumeric.
crn
*
String
Mandatory
Complaint reference number returned by NPCI
Constraint: 14 to 16 characters alphanumeric.
orgTxnDate
*
String
Mandatory
Transaction timestamp
Timestamp (YYYY-MM-DDTHH:MM:SS+05:30)
complaintDate
*
String
Mandatory
Complaint timestamp
Timestamp (YYYY-MM-DDTHH:MM:SS+05:30)
status
*
String
Mandatory
Status of the complaint
Values- CLOSED, PENDING, FAILURE, OPEN
remarks
*
String
Mandatory
remarks of the complaint
reqAdjAmount
*
String
Mandatory
Amount of the transaction sent by NPCI
reqAdjFlag
*
String
Mandatory
Reason flag for complaint sent by NPCI
reqAdjCode
*
String
Mandatory
Reason Code for complaint sent by NPCI
udfParameters
Json String
Optional
Udf parameters as passed in the request