Body
Complaint Raise
This Api will be used to raise a complaint on any transactions.
Note
Complaints shall be allowed only after '5' mins from the time of transaction and after transaction status check is done by the user.
Complaints can be raised on P2P (Deemed and DRC) transactions and P2M (Success,Deemed,DRC) transactions.
For the below request type = "COMPLAINT" will correspond to one of the categories of "reqComplaint" api. We currently only use "COMPLAINT" because we don't serve other use cases. We have kept it as a field in request body for future api enhancements.
Provide request parameters "adjCode" and "adjFlag" based on below scenarios.
-pzR3H.png)
Request
Response
API Endpoints
Production Link
POST
http://{{lhost}}/api/{uri}/merchants/complaints/raise
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
adjAmount
*
String
Mandatory
Amount of the transaction sent to NPCI.
Constraint: Amount in two decimals. Decimals are mandatory.
adjFlag
*
String
Mandatory
Reason flag for complaint sent to NPCI
adjCode
*
String
Mandatory
Reason Code for complaint sent to NPCI
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer
Constraint: Alphanumeric string with dot(.). Maximum length is 256.
merchantRequestId
*
String
Mandatory
Merchant generated id for the complaint request
Constraint: 35 characters alphanumeric.
originalUpiRequestId
*
String
Mandatory
Unique id sent to UPI switch for the request of the transaction on which complaint complaint needs to raise
Constraint: 35 character alphanumeric. Should always start with merchant prefix provided.
type
*
String
Mandatory
Define the type of request
String - COMPLAINT
upiRequestId
*
String
Mandatory
Unique id sent to UPI switch for the request
Constraint: 35 character alphanumeric. Should always start with merchant prefix provided.
remarks
Optional
String
Remarks or reason for complaint
initiationMode
optional
String
Defines the initiation mode of the transaction
purpose
Optional
String
Defines the purpose code of the transaction
refUrl
optional
String
Invoice as sent by merchant in the form of url
refCategory
Optional
String
Details for refUrl, whether it is 01(advertisement), 02(invoice)
udfParameters
Json 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
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
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer as passed in the request
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
customerMobileNumber
*
String
Mandatory
Customer mobile number as per device binding
Constraint: 12 digits mobile number
merchantRequestId
*
String
Mandatory
Merchant generated id for the transaction
Constraint: 35 characters alphanumeric.
transactionAmount
*
String
Mandatory
The total amount for which original transaction was performed
Constraint: String with mandatory two decimals
reqAdjAmount
*
String
Mandatory
Amount of the transaction sent to NPCI
Constraint: Amount in two decimals.
reqAdjFlag
*
String
Mandatory
Reason flag for complaint sent to NPCI
reqAdjCode
*
String
Mandatory
Reason Code for complaint sent to NPCI
crn
String
optional
Complaint reference number returned by NPCI
Constraint: 14 to 16 characters alphanumeric.
gatewayReferenceId
*
String
Mandatory
Reference id returned by the gateway
gatewayComplaintId
*
String
Mandatory
Complaint id returned by gateway
gatewayResponseCode
*
String
Mandatory
Response code returned by gateway
gatewayResponseStatus
*
String
Mandatory
Response status returned by gateway
Values: PENDING | FAILURE
gatewayResponseMessage
*
String
Mandatory
Response message for code returned by gateway
udfParameters
Json String
Optional
Udf parameters as passed in the request
Have questions?
- Need help? Contact support
- LLM? Read llms.txt