Body
Update/Revoke Mandate
This api will be used for updating / revoking a mandate. requestType can be UPDATE or REVOKE.If requestType is UPDATE then the entity (PAYER/PAYEE) whoever has initiated the create mandate request can update the mandate. If mandate is updated by PAYER then credBlock is required and when it is updated by PAYEE then approval is required by PAYER. Only amount and validityEnd can be updated. If requestType is REVOKE then mandate will be revoked. If REVOKE request is initiated by PAYEE then credBlock is not required and vice-versa.
Note
This API hits TSP Server with a timeout of 60 seconds.
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{uri}/merchants/mandates/update
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.
x-timestamp
*
String
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.
Request Schema: application/json
Parameter
amount
String
conditional
Amount for mandate. Only required if amount needs to be updated for mandate and requestType is UPDATE. Either one of validityEnd or amount has to be passed.
Constraints:Amount in two decimals. Decimals are mandatory.
bankAccountUniqueId
optional
String
Unique id for the selected bank account. Should be same bankId used while create or approve mandate. It is not required when initiatedBy PAYEE.
Constraints:String. As passed for bankAccountUniqueId in request.
credBlock
optional
Json String
Encrypted credblock containing user mpin. It is required if mandate update or revoke is initiatedBy Payer
Constraints:As returned by Common Library.
deviceFingerPrint
optional
String
Device fingerprint of the customer. It is required if mandate update or revoke is initiatedBy Payer
expiry
optional
Numeric String
Minutes for which request is valid. It is required only when requestType is UPDATE.
Constraints:A number between 2 to 64800, both inclusive, in String format.
makeAsync
optional
Boolean
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 initiatedBy PAYEE and requestType is UPDATE as it will be default async as it requires approval from Customer.
Constraints:true,false
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer
Constraints:Alphanumeric string with dot(.). Maximum length is 256.
merchantRequestId
*
String
Mandatory
Merchant generated request id for the mandate operation.
Constraints:35 character alphanumeric unique id.
orgMandateId
*
String
Mandatory
gatewayMandateId of the original mandate
remarks
optional
String
Any mandate summary
requestType
*
String
Mandatory
Type of mandate operation request. If requestType is UPDATE, mandate's validityEnd and amount can be updated. If requestType is REVOKE, mandate will be revoked.
Constraints:UPDATE, REVOKE
udfParameters
optional
Json String
Stringified json for udf parameters.
Constraints:String "udfParameters" : "{}"
upiRequestId
*
String
Mandatory
Unique id passed to NPCI.
Constraints:35 character alphanumeric. Should always start with a unique merchant prefix.
validityEnd
String
conditional
Date before which mandate can 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.
Constraints:String with proper date format YYYY/MM/DD
clVersion
String
Optional
Common Library Version of the UPI application clVersion
Constraints: Common Library Version of the UPI application (Mandatory for BioAuth payments)
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
amount
*
String
Mandatory
Updated amount for mandate. If only validityEnd is updated then amount will be same as it was passed during creation of mandate.
Values:Numeric String
amountRule
*
String
Mandatory
Rule on Mandate Amount. If amountRule is MAX, then mandate can be executed for amount less than or equal to the passed amount . If amountRule is EXACT, then mandate should always be executed for the same amount.
Values:As passed for amountRule in create mandate.
bankAccountUniqueId
*
String
Mandatory
Unique id for the selected bank account
Values:bankAccountUniqueId in the response of Fetch Accounts api call. As passed for bankAccountUniqueId in request. If not send in the request then bankAccountUniqueId that was used during creation of mandate will be send.
blockFund
*
String
Mandatory
Denotes whether customer's fund should be blocked or not. For onetime mandate it can be true or false. Default value is false.
Values:String - true,false
expiry
String
optional
Timestamp upto which mandate updation request is valid. It will only be present if mandate updation is initiated by PAYEE.
Values:Timestamp in YYYY-MM-DDTHH:MM:SS+05:30 format, request timestamp plus expiry minutes passed in request.
gatewayMandateId
*
String
Mandatory
UPI request id passed in request
Values:As passed for upiRequestId in request
gatewayReferenceId
*
String
Mandatory
Customer reference number (rrn) for the mandate operation.
gatewayResponseCode
*
String
Mandatory
Response code returned by gateway for the mandate operation.
Values:Refer to table below.
gatewayResponseMessage
*
String
Mandatory
Response message returned by gateway for the mandate operation.
gatewayResponseStatus
*
String
Mandatory
Response status returned by gateway
Values:SUCCESS, FAILURE
initiatedBy
*
String
Mandatory
Describes whether PAYER or PAYEE has initiated the mandate operation request.
Values:PAYER, PAYEE
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:String. As passed during creation of mandate.
mandateTimestamp
*
String
Mandatory
Timestamp of when this request was attempted.
mandateType
*
String
Mandatory
Defines the type of mandate request
Values:UPDATE, REVOKE
merchantChannelId
*
String
Mandatory
Unique id for the merchant channel.
Values:As passed for x-merchant-channel-id in request headers.
merchantCustomerId
*
String
Mandatory
Merchant generated unique id for customer.
Values:Alphanumeric string with dot(.). Maximum length is 256. As passed for merchantCustomerId in request.
merchantId
*
String
Mandatory
Unique id for the merchant.
Values:As passed for x-merchant-id in request headers
merchantRequestId
*
String
Mandatory
Merchant generated id for the mandate request.
Values:As passed for merchantRequestId in request body.
orgMandateId
*
String
Mandatory
gatewayMandateId returned in create mandate
Values:As passed for orgMandateId in request
payeeMcc
*
String
Mandatory
Merchant Category Code of the payee merchant.
payeeName
String
optional
Name of the Payee involved in mandate.
payeeVpa
*
String
Mandatory
VPA of Payee.
Values:String. As passed during creation of mandate.
payerName
String
optional
Name of the Payer involved in mandate.
payerRevocable
*
String
Mandatory
Defines whether mandate is revocable by PAYER or not. For onetime mandate it can be true or false. Default value is true.
Values:String - true,false
payerVpa
*
String
Mandatory
VPA of Payer.
Values:String. As passed during creation of mandate.
recurrencePattern
*
String
Mandatory
Recurrence Pattern for Mandate
Values:String. Same as original mandate in create or list mandate response.
recurrenceRule
String
optional
Recurrence Rule for Mandate. It will not be present for ONETIME, DAILY and ASPRESENTED recurrence pattern.
Values:Same as original mandate in create or list mandate response.
recurrencValue
String
optional
Values:Recurrence Value for Mandate. It will not be present for ONETIME, DAILY and ASPRESENTED recurrence pattern.
Values:String. Same as original mandate in create or list mandate response.
refUrl
*
String
Mandatory
Invoice as sent by merchant or reference to the mandate in the form of url.
Values:String. As passed during creation of mandate.
remarks
*
String
Mandatory
Any mandate summary. If pssed in request, it will be same in response else a default value is send.
role
*
String
Mandatory
Role of the customer for this mandate.
Values:PAYER, PAYEE
shareToPayee
*
String
Mandatory
Descibes whether mandate will be shared with payee or not. For onetime mandate it can be true or false. Default value is true.
Values:String - true,false
transactionType
*
String
Mandatory
Type of Mandate Operation
Values:UPI_MANDATE, QR_MANDATE, INTENT_MANDATE, P2M_MANDATE
umn
*
String
Mandatory
Unique Mandate Number used for execution of the 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.
Values:String with proper date format YYYY/MM/DD.
validityStart
*
String
Mandatory
Date after which mandate can be executed
Values:String with proper date format YYYY/MM/DD
udfParameters
Json String
Optional
Udf parameters as passed in the request.
Values:As passed for udfParameters in request.
Have questions?
- Need help? Contact support
- LLM? Read llms.txt