Body
Pause/Unpause Mandate
This api will be used for PAUSE/UNPAUSE an active mandate. requestType can be PAUSE or UNPAUSE. If requestType is PAUSE then pauseStart, pauseEnd are required. pauseStart and pauseEnd are not required when requestType is UNPAUSE. Pause and Unpause request can always be initiatedBy Payer. credBlock is required for both during PAUSE and UNPAUSE.
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{uri}/merchants/mandates/pause
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
bankAccountUniqueId
*
String
Mandatory
Unique id for the selected bank account
Constraints:bankAccountUniqueId in the response of Fetch Accounts api call.
credBlock
*
String
Mandatory
Encrypted credblock containing user mpin
Constraints:As returned by Common Library
deviceFingerPrint
*
String
Mandatory
Device fingerprint of the customer
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.
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 id for the mandate
Constraints:35 character alphanumeric unique id.
orgMandateId
*
String
Mandatory
gatewayMandateId returned during create mandate
Constraints:String and it should be corresponding Upi Request id used during create mandate.
pauseEnd
optional
Defines the date on which the mandate should unpause. Only required when requestType is PAUSE
Constraints:Date in "YYYY/MM/DD".
pauseStart
optional
Defines the date from which the mandate should pause. Only required when requestType is PAUSE
Constraints:Date in "YYYY/MM/DD".
remarks
optional
String
Any mandate summary
requestType
*
String
Mandatory
Type of Mandate Request
Constraints:PAUSE, UNPAUSE.
udfParameters
optional
Stringified json for udf parameters.
Constraints:String "udfParameters" : "{}"
upiRequestId
*
Json String
Mandatory
Unique id sent to UPI switch for the request
Constraints:35 character alphanumeric. Should always start with a unique merchant prefix.
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
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
Mandatory
Unique id for the selected bank account as passed in request. It should be same as the one that was used during creation of mandate.
Values:bankAccountUniqueId in the response of Fetch Accounts api call.
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
gatewayMandateId
*
String
Mandatory
upiRequestId passed in the 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 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.
Values:(YYYY-MM-DDTHH:MM:SS+05:30)
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 the 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.
pauseEnd
String
optional
Defines the date on which the mandate should unpause. It will only be present if requestType is PAUSE.
Values:As passed in request.
pauseStart
String
optional
Defines the date from which the mandate should pause. It will only be present if requestType is PAUSE.
Values:As passed 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: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: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
Date before which mandate can be executed
Values:Date in "YYYY/MM/DD"
validityStart
*
String
Mandatory
Date after which mandate can be executed
Values:Date in "YYYY/MM/DD"
udfParameters
json String
optional
Udf parameters as passed in the request.As passed for
Values:udfParameters in request
Have questions?
- Need help? Contact support
- LLM? Read llms.txt