Body
Web Notify
This api will be used for notifying the Payer by the Merchant prior to the execution.
Request
Response
API Endpoints
Production Link
POST
{{host}}/api/{{uri}}/merchants/mandates/webNotify
Headers
jpupi-routing-id
*
String
Mandatory
Header value should be same as of originalMerchantRequestId sent in request body
Request parameters
amount
*
String
Mandatory
Amount for which customer is notified for execution.
Constraints:Amount in two decimals. Decimals are mandatory.
mandateExecutionTimestamp
*
String
Mandatory
Mandate execution timestamp (Future Timestamp on which mandate will be executed)
Format:String with proper date format (YYYY-MM-DDTHH:MM:SS+05:30)
merchantRequestId
*
String
Mandatory
Merchant generated unique id for for the Notification.
Constraint: Max 35 characters alphanumeric, can also contain hyphen(-), dot(.) & underscore(_)
remarks
String
optional
Remarks sent by merchant for notify mandate
Constraint: The transaction note must be alphanumeric, with a minimum length of 1 character and a maximum length of 50 characters.
umn
*
String
Mandatory
umn returned in create mandate callback
Constraints:35 character alphanumeric unique id.
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 customer is notified for execution.
Values:As passed in request
gatewayResponseCode
*
String
Mandatory
Response code returned by gateway for the notification.
gatewayResponseMessage
*
String
Mandatory
Response message returned by gateway for the notification.
gatewayResponseStatus
*
String
Mandatory
Response status returned by gateway.
Values:PENDING, FAILURE
gateWayTransactionId
*
String
Mandatory
upiRequestId as passed in 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 timestamp (Future Timestamp on which mandate will be executed)
Values:As passed in request
orgMandateId
*
String
Mandatory
gatewayMandateId returned in create mandate
Values:As passed for gatewayMandateId in webMandate request.
remarks
*
String
Mandatory
Any mandate notification summary. If pssed in request, it will be same in response else a default value is send.
umn
*
String
Mandatory
umn returned in create mandate callback
Values:As passed in request
seqNumber
String
optional
Sequence Number of Mandate execution
udfParameters
Stringified JSON
optional
Merchant Defined Parameters
Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"