Body
Notification Status
This api will be used by Merchant for checking the status of the mandate notification.
Request
Response
API Endpoints
Production Link
POST
{{host}}/api/{{uri}}/merchants/mandates/webNotify/status
Headers
jpupi-routing-id
*
String
Mandatory
Header value should be same as of originalMerchantRequestId sent in request body
Request parameters
merchantRequestId
*
String
Mandatory
merchantRequestId of the Notification whose status is to be checked.
iat
*
String
Mandatory
Current Epoch Unix timestamp string. Has to be of 13 digit in Milliseconds.
Example: 1496918882000.
originalMerchantRequestId
String
Optional But Mandatory For New Integration
Merchant request of the original create mandate request.
udfParameters
Stringified JSON
Optional
Merchant Defined Parameters
Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"
Note: Few special characters are not allowed. Regex for the characters which are not allowed : ^[^/#-()*!%~`]+$
200 : Success
Response Body
status
*
String
Mandatory
Status of the API.
Values:SUCCESS, FAILURE.
responseCode
*
String
Mandatory
PSP response code for the API.
Values: Refer Codes Guide in Resource Section.
responseMessage
*
String
Mandatory
PSP response message for the API.
Values: Refer Codes Guide in Resource Section.
payload
*
json
Mandatory
amount
*
String
Mandatory
Amount for which merchant requested the mandate
Values:As passed in request
gatewayResponseCode
*
String
Mandatory
Response code returned by gateway for the notification.
Values:00
gatewayResponseMessage
*
String
Mandatory
Response message returned by gateway for the transaction.
gatewayResponseStatus
*
String
Mandatory
Response message returned by gateway for the notification.
gatewayTransactionId
*
String
Mandatory
upiRequestId as passed on request
merchantChannelId
*
String
Mandatory
Unique id for the channel via which request is made.
Values:As passed in request.
merchantId
*
String
Mandatory
Unique id for merchant.
Values:As passed in request.
merchantRequestId
*
String
Mandatory
Merchant generated unique id for collect request.
Constraint: Max 35 characters & Alphanumeric.
nextExecution
*
String
Mandatory
Mandate execution time in minutes from current time.
Format:String with proper date format (YYYY-MM-DDTHH:MM:SS+05:30).
orgMandateId
*
String
Mandatory
gatewayMandateId returned in create mandate.
Values:As passed for gatewayMandateId in webMandate request.
umn
*
String
Mandatory
umn returned in create mandate callback.
Values:As passed in request.
seqNumber
String
optional
Sequence Number of execution.
gatewayReferenceId
String
optional
Customer reference number (rrn) for the transaction.
udfParameters
Stringified JSON
optional
Merchant Defined Parameters
Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"