JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Raise Complaint

This API can be used to raise a complaint for any transaction. User will be able to raise this in case of a success, failure or a deemed transaction.

Process Parameters

Request

Response

                      requestId
                      *
                      

String

Mandatory

Unique uuid-v4 string

Example: abcd-12345-abcd-12345

                      service
                      *
                      

String

Mandatory

Value: in.juspay.hyperapi

                      payload
                      *
                      

JSON

Mandatory

Parameters required to call Hyper SDK API

                      action
                      *
                      

String

Mandatory

Operation to be performed in the SDK

Example:- upiComplaintRaise

                      upiRequestId
                      *
                      

Alphanumneric

String

Mandatory

Unique id passed to NPCI. 35 character alphanumeric string. Should always start with the merchant prefix provided. Should be unique.

Example:- Eg - APL0f018ee5bc8b428fb979cb4a53ea9bde

                      originalUpiRequestId
                      *
                      

Alphanumeric

String

Mandatory

Unique Transaction original id of the transaction on which complaint needs to raise (gatewayTransactionid). 35 character alphanumeric. Should always start with the merchant prefix provided. Should be unique.

Example:- Eg - APL0f018ee5bc8b428fb979cb4a53ea9bde

                      remarks
                      *
                      

String

Mandatory

Remarks or reason for complaint

                      adjAmount
                      *
                      

String

Mandatory

Amount in two decimals. Decimals are mandatory.

Example:- 0.50

                      adjFlag
                      *
                      

String

Mandatory

Reason flag for complaint

Example:- PBRB

                      adjCode
                      *
                      

String

Mandatory

Reason code for complaint

Example:- U010

                      type
                      *
                      

String

Mandatory

Define the type of request

Example:- COMPLAINT/TXNDISPUTE

                      merchantKeyId
                      *
                      

String

Mandatory

Key ID to identify the public-private key pair used for signature generation.

                      signaturePayload
                      *
                      

String

Mandatory

Signature payload is a stringified JSON of the details mentioned in the below table.

                      merchant_id
                      *
                      

String

Mandatory

Unique identifier associated with an account created by juspay. Ex: stock

Example:- stock

                      customer_id
                      *
                      

String

Mandatory

Any unique reference associated with your customer.

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds.

                      signature
                      *
                      

String

Mandatory

Signature generated for the signaturePayload.

                      purpose
                      
                      

String

Optional

Defines the purpose code of the transaction

                      refUrl
                      
                      

String

Optional

Example:- "https://www.abcxyz.com/"

Adjustment Code Table