Body
Raise A query
This api can be used to raise a query on a deemed transaction. The query should be raised 2 days after the transaction attempt.
Request
Response
API Endpoints
Production Link
POST
http://{{lhost}}/api/{uri}/merchants/transactions/query/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
*
integer
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.
upiRequestId
*
String
Mandatory
Unique id sent to UPI switch for the request
Constraint: 35 character alphanumeric. Should always start with merchant prefix provided.
upiResponseId
*
String
Mandatory
RRN of the transaction on which query is raised
Constraint: 12 digit numeric string
queryComment
String
Optional
A comment specifying the query regarding the issue
Constraint: 0-255 characters alphanumeric
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
customerMobileNumber
*
String
Mandatory
Customer mobile number as per device binding
Constraint: 12 digits mobile number
queryReferenceId
*
String
Mandatory
PSP generated unique id for the query
queryComment
String
Optional
The query description as sent in the request
Constraint: 0-255 characters alphanumeric
gatewayTransactionId
*
String
Mandatory
upiRequestId as passed in request
gatewayReferenceId
*
String
Mandatory
upiResponseId as passed in request
gatewayResponseStatus
*
String
Mandatory
Response status returned by gateway
Values: SUCCESS|FAILURE
gatewayResponseCode
*
String
Mandatory
Response code returned by gateway
gatewayResponseMessage
*
String
Mandatory
Response message for code returned by gateway
udfParameters
Json String
Optional
Udf parameters as passed in the request