Body
Query Status
This api can be used to check the status of a previously raised query.
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{uri}/merchants/transactions/query/status
Headers
Content-Type
*
string
Required
application/json
x-merchant-signature
*
string
Required
This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.
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.
Parameters
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer
Constraints : Alphanumeric string with dot(.). Maximum length is 256.
upiRequestId
*
String
Mandatory
UPI request id of the transaction on which the query was raised
Constraints : 35 character alphanumeric
upiResponseId
*
String
Mandatory
RRN of the transaction on which query is raised
Constraints : 12 digit numeric string
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
Values : Refer error code section
responseMessage
*
String
Mandatory
PSP response message for the API
Values : Refer error code section
payload
*
JSON
Mandatory
Callback data in appropriate format for the transactionType passed in the request. Refer Transaction API Callbacks section for more details.
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
Values : 12 digits mobile number string
queryReferenceId
*
String
Mandatory
PSP generated unique id for the query
Values : QUERY123
queryComment
String
optional
The query description as sent in the request
Values : 0-255 characters alphanumeric
queryClosingTimestamp
optional
Timestamp of when the query was closed
Values : YYYY-MM-DDTHH:MM:SS+05:30
gatewayTransactionId
*
String
Mandatory
upiRequestId as passed in request
gatewayReferenceId
*
String
Mandatory
upiResponseId as passed in request
gatewayResponseStatus
*
String
Mandatory
Response status returend by gateway
Values : OPEN, CLOSED
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