Body
Approve/Decline WebMandate
This api is to review and take some action on a pending mandate request. requestType can be APPROVE or DECLINE. If requestType is APPROVE, then bankAccountUniqueId and credBlock parameters are mandatory. A mandate request approve is success if gatewayResponseCode is 00. A mandate request decline is success if gatewayResponseCode is ZA if action is against a create mandate request and gatewayResponseCode is QT if action is against an update mandate. The gatewayResponseStatus for a successful decline will be DECLINED.
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{uri}/merchants/mandates/approve
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.
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.
Parameter
bankAccountUniqueId
optional
Unique id for the selected bank account. Should always use the same account for all operations of a single mandate. It is only required when requestType is APPROVE.
Constraints:bankAccountUniqueId in the response of Fetch Accounts api call.
credBlock
optional
Encrypted credblock containing user mpin. It is required when requestType is APPROVE.
Constraints:As returned by Common Library
deviceFingerPrint
String
optional
Device fingerprint of the customer. It is required when requestType is APPROVE.
makeAsync
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.
mandateRequestId
*
String
Mandatory
upiRequestId used during create or update mandate based on whether create or update mandate request is getting approved.
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for
Constraints:customerAlphanumeric string with dot(.). Maximum length is 256.
merchantRequestId
*
String
Mandatory
Merchant generated id for the mandate request
Constraints:35 character alphanumeric unique id.
requestType
*
String
Mandatory
Action to be taken on the mandate request
Constraints:APPROVE or DECLINE
udfParameters
optional
Stringified json for udf parameters.
Constraints:String "udfParameters" : "{}"
umn
optional
String
Required when requestType is APPROVE and the umn of the mandate to be approved is null. Sets the umn of the mandate.
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
*
String
Mandatory
amount
*
String
Mandatory
Updated Amount for mandate
Values:Amount in two decimals. Decimals are mandatory. As passed during creation of mandate.
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
optional
Unique id for the selected bank account. It will not be present if requestType is DECLINE.
Values:bankAccountUniqueId in the response of Fetch Accounts api call. As passed for bankAccountUniqueId in request.
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
Mandatory
Timestamp until which mandate request is valid
Values:Timestamp in YYYY-MM-DDTHH:MM:SS+05:30 format.
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, DECLINED
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.
mandateApprovalTimestamp
String
Optional
Time instant at which create mandate request was approved. Only present if mandate type is create and approved.
Values:YYYY-MM-DDTHH:MM:SS+05:30.
mandateName
*
String
Mandatory
Name of the mandate
Values:String. As passed during creation of mandate.
mandateTimestamp
*
String
Mandatory
Timestamp of when this request was created.
Values:(YYYY-MM-DDTHH:MM:SS+05:30)
mandateType
*
String
Mandatory
Defines the type of mandate
Values:CREATE, UPDATE
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.
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
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. It will be the same value that was used during create mandate response.
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
Date before which mandate can be executed.
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.