Body
Complaint Status
This api will be used for checking the status of complaints raised on any transactions.
Note
Transaction and Complaints Status check shall be allowed only after '3' mins from the time of respective txn.
Per day only 3 check status can be done to the NPCI UDIR system, after that PSP will pick the status from the database and that will be shared.
For the below request type = "TXNDISPUTE" will correspond to one of the subTypes of "reqComplaint" api where we specify whether we want the status for txn, dispute or both. Currently we don't serve other use cases. We have kept it as a field in request body for future api enhancements.
Request
Response
API Endpoints
Production Link
POST
http://{{lhost}}/api/{uri}/merchants/complaints/status
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
Mandatory
Merchant generated unique profile id for customer
Constraint: Alphanumeric string with dot(.). Maximum length is 256.
originalTransactionUpiRequestId
*
String
Mandatory
Original Transaction Unique id sent to UPI switch for the request
Constraint: 35 character alphanumeric. Should always start with merchant prefix provided.
type
*
String
Mandatory
Type of Complaint Status
Value- String TXNDISPUTE
originalUpiRequestId
*
String
Mandatory
Unique id sent to UPI switch for the request
Constraint: 35 character alphanumeric. Should always start with merchant prefix provided.
udfParameters
String
Optional
Stringified JSON for udf parameters
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
merchantChannelId
*
String
Mandatory
Unique id for the merchant channel as passed in request headers
gatewayResponseStatus
*
String
Mandatory
Response status returned by gateway
Values: OPEN|CLOSED| PENDING|FAILURE
merchantId
*
String
Mandatory
Unique id for the merchant as passed in request headers
gatewayComplaintId
*
String
Mandatory
Complaint id returned by gateway
reqAdjAmount
*
String
Mandatory
Amount of the transaction sent to NPCI when complaint was raised
Constraint: Amount in two decimals.
gatewayResponseMessage
*
String
Mandatory
Response message for code returned by gateway
payerVpa
*
String
Mandatory
VPA of the customer to be used for payment
merchantRequestId
*
String
Mandatory
Merchant generated id for the transaction
gatewayResponseCode
*
String
Mandatory
Response code returned by gateway
gatewayReferenceId
*
String
Mandatory
Reference id returned by the gateway
reqAdjCode
*
String
Mandatory
Reason Code for complaint sent to NPCI when complaint was raised
crn
String
Optional
Complaint reference number returned by NPCI
Constraint: 14 to 16 characters alphanumeric.
customerMobileNumber
*
String
Mandatory
Customer mobile number as per device binding
Constraint: 12 digits mobile number string
payeeVpa
*
String
Mandatory
Vpa for customer who received the payment
reqAdjFlag
*
String
Mandatory
Reason flag for complaint sent to NPCI when complaint was raised
transactionAmount
*
String
Mandatory
The total amount for which original transaction was performed.
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer as passed in the request
udfParameters
Json String
Optional
Have questions?
- Need help? Contact support
- LLM? Read llms.txt