Body
Web Update
This api will be used for updating or revoking the mandate which is already created by Merchant to the Payer. Only validityEnd and amount of the original mandate can be updated. Either one of the two parameters is necessary when requestType is "UPDATE".
Note
For mandates created through Register Intent, merchant can revoke the mandates but can not update.
Request
Response
API Endpoints
Production Link
POST
{{host}}/api/{{uri}}/merchants/mandates/webUpdate
Headers
jpupi-routing-id
*
String
Mandatory
Header value should be same as of originalMerchantRequestId sent in request body
Request parameters
amount
String
conditional
Amount for mandate. Only required if amount needs to be updated.
Constraints: Amount in two decimals. Decimals are mandatory.
makeAsync
String
optional
Denotes whether the API call will be done in synchronous or asynchronous manner. If it is not passed by default API call will be in synchronous. It is not required if requestType is UPDATE as it will be default async as it requires approval from Customer.
Constraints: true,false
mandateRequestExpiryMinutes
*
String
Mandatory
Minutes for which request is valid
Format:A number between 1 to 64800, both inclusive, in String format.
merchantRequestId
*
String
Mandatory
Merchant generated unique id for this particular request.
Constraint: Max 35 characters alphanumeric, can also contain hyphen(-), dot(.) & underscore(_)
remarks
String
optional
Any mandate summary.
Constraint: The transaction note must be alphanumeric, with a minimum length of 1 character and a maximum length of 50 characters.
requestType
*
String
Mandatory
differentiate the request for UPDATE and REVOKE
Constraints:String but allowed values are only UPDATE and REVOKE
validityEnd
String
conditional
Date after which mandate cannot be executed. Only required if validity end date needs to be updated for mandate and requestType is UPDATE. Either validityEnd or amount has to be passed.
Format:String with proper date format YYYY/MM/DD
originalMerchantRequestId
String
Optional But Mandatory For New Integration
Merchant request of the original create mandate request.
iat
*
String
Mandatory
Current Epoch Unix timestamp string. Has to be of 13 digit in Milliseconds.
Example: 1496918882000.
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
Conditional
Updated amount for mandate. If only validityEnd is updated then amount will be same as it was passed during creation of mandate.
Values:Numeric
customerVpa
*
String
Mandatory
VPA on which request mandate should be triggered
Values:Vpa for which mandate was requested during webMandate
expiry
*
String
Mandatory
Minutes for which request is valid
Format:Timestamp in YYYY-MM-DDTHH:MM:SS+05:30 format, request timestamp plus expiry minutes passed in request.
gatewayMandateId
*
String
Mandatory
UPI request id returned by gateway for the mandate
Values:As passed for upiRequestId in request
gatewayResponseCode
*
String
Mandatory
Response code returned by gateway for the transaction.
Values:00
gatewayResponseMessage
*
String
Mandatory
Response message returned by gateway for the transaction.
gatewayResponseStatus
*
String
Mandatory
Response status returned by gateway.
Values:SUCCESS, FAILURE
makeAsync
String
optional
Denotes whether the API call will be done in synchronous or asynchronous manner
Values:Only present if passed in reqBody and same value as in request.
mandateName
*
String
Mandatory
Name of the mandate
Values:Name of the mandate
mandateTimestamp
*
String
Mandatory
Timestamp of when the webMandate was initiated
Format:(YYYY-MM-DDTHH:MM:SS+05:30)
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.
orgMandateId
*
String
Mandatory
gatewayMandateId returned in create mandate
Values:As passed in request
remarks
*
String
Mandatory
Any mandate summary. If pssed in request, it will be same in response else a default value is send.
umn
*
String
Mandatory
Vpa used for execution of mandate.
validityEnd
*
String
Mandatory
Updated date before which mandate can be executed. If only amount is updated then validityEnd will be same as it was passed during creation of mandate.
Format:String with proper date format YYYY/MM/DD.
originalMerchantRequestId
String
optional
Merchant request id of the original mandate
mandateType
String
optional
requestType as sent in Request body
udfParameters
Stringified JSON
optional
Merchant Defined Parameters
Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"