Pause
Notifications and alerts for pausing mandate (initiated by customer)
PREREQUISITES
🌟 UPI mandate pause ↗These are the available webhooks for merchants, when their customers attempt to pause their mandate (which can be a temporary action). Here is a quick view of how the status moves from mandate.live to mandate.paused—
The following param values indicate this state—
operationwill bepauseeventTypewill bemandate_operation.pause.initiatedstatuswill beinitiated
{
"eventId": "1c94fdeb-2167-443d-99f4-f5fe21d079ae", // Unique event identifier, generated using UUID
"eventType": "mandate_operation.pause.initiated",
"eventTs": "2025-06-29T19:12:35+05:30", // Event timestamp
"resource": "mandate_operation",
"id": "01JYXYSV8B19XAWSFRPARXY35E", // Mandate operation ID
"operation": "pause",
"status": "initiated",
// Empty reason object for initiated status
"reason": {},
// Merchant and Reference Information
"merchantId": "01JYXYSV8B19XAWSFRPARXY35E", // Merchant ID
"merchantReferenceId": "mandate_123456789", // mandate referenceId
"txnId": "HDF10e4ab8a07f447eea54581383d92b507", // NPCI Txn.id
"txnTs": "2025-06-29T19:12:35+05:30", // NPCI Txn.ts
"rrn": "123456789012", // NPCI Txn.custRef
"umn": "c27f5fc30d344e9594fce0afa34f8859@mypsp", // Unique Mandate Number from NPCI
"mandateId": "01JYXYSV8B19XAWSFRPARXY35E", // ID of the mandate being operated on
// Amount Information
"amount": 1000, // Mandate amount in paise
"amountLimit": 1000, // Mandate amount in paise
"endDate": "20032025", // Mandate end date in DDMMYYYY format
// TPV Specific Information (empty object for non-TPV mandates)
"customerAccount": { // Payer account details, empty object for non-TPV mandates
"encryptedAccountNumber": "fhDBZ4fC2RtNyiW5rB-jDnzzs_YpYwPGerwAwDTd", // Encrypted account number
"hashedAccountNumber": "d49f354241572a261cfd3a7f210f1919c79fa9993b29e34c5511c3ecefc9f3ea", // Hashed account number
"maskedAccountNumber": "**** **** **** 1234", // Masked account number
"hashedAccountName": "cceaad99aec841a21be45f02368d0d332493a5a62fdda20c3d85bfb617ef176b", // Hashed account name
"maskedAccountName": "M*N* T*O*M*A*S", // Masked account name
"encryptedAccountName": "n6MUSW1KXaSWh1E38zxhh1amv9E6rPmZ2Tw=", // Encrypted account name
"ifsc": "HDFC0000053", // IFSC code
"accountType": "SAVINGS" // Account type
}
}The following param values indicate this state—
operationwill bepauseeventTypewill bemandate_operation.pause.successstatuswill besuccess
{
"eventId": "1c94fdeb-2167-443d-99f4-f5fe21d079ae", // Unique event identifier, generated using UUID
"eventType": "mandate_operation.pause.success",
"eventTs": "2025-06-29T19:12:35+05:30", // Event timestamp
"resource": "mandate_operation",
"id": "01JYXYSV8B19XAWSFRPARXY35E", // Mandate operation ID
"operation": "pause",
"status": "success",
"reason": {
"code": "mandate-operation-success", // Reason code
"desc": "mandate operation has succeeded", // Reason description
"npciErrCode": "00", // NPCI error code
"npciErrDesc": "SUCCESS", // NPCI error code description
"npciErrCategory": "NA", // NPCI error category
"npciRespCode": "00", // NPCI response code
"npciRespDesc": "SUCCESS", // NPCI response code description
"setuDescription": "", // Setu description
"suggestedAction": "" // Suggested action
},
// Merchant and Reference Information
"merchantId": "01JYXYSV8B19XAWSFRPARXY35E", // Merchant ID
"merchantReferenceId": "mandate_123456789", // mandate referenceId
"txnId": "HDF10e4ab8a07f447eea54581383d92b507", // NPCI Txn.id
"txnTs": "2025-06-29T19:12:35+05:30", // NPCI Txn.ts
"rrn": "123456789012", // NPCI Txn.custRef
"umn": "c27f5fc30d344e9594fce0afa34f8859@mypsp", // Unique Mandate Number from NPCI
"mandateId": "01JYXYSV8B19XAWSFRPARXY35E", // ID of the mandate being operated on
// Amount Information
"amount": 1000, // Mandate amount in paise
"amountLimit": 1000, // Mandate amount in paise
"endDate": "20032025", // Mandate end date in DDMMYYYY format
// TPV Specific Information (empty object for non-TPV mandates)
"customerAccount": { // Payer account details, empty object for non-TPV mandates
"encryptedAccountNumber": "fhDBZ4fC2RtNyiW5rB-jDnzzs_YpYwPGerwAwDTd", // Encrypted account number
"hashedAccountNumber": "d49f354241572a261cfd3a7f210f1919c79fa9993b29e34c5511c3ecefc9f3ea", // Hashed account number
"maskedAccountNumber": "**** **** **** 1234", // Masked account number
"hashedAccountName": "cceaad99aec841a21be45f02368d0d332493a5a62fdda20c3d85bfb617ef176b", // Hashed account name
"maskedAccountName": "M*N* T*O*M*A*S", // Masked account name
"encryptedAccountName": "n6MUSW1KXaSWh1E38zxhh1amv9E6rPmZ2Tw=", // Encrypted account name
"ifsc": "HDFC0000053", // IFSC code
"accountType": "SAVINGS" // Account type
}
}In addition to mandate_operation.pause.success, a mandate.paused event is also sent.
{
"eventId": "1c94fdeb-2167-443d-99f4-f5fe21d079ae", // Unique event identifier, generated using UUID
"eventType": "mandate.paused",
"eventTs": "2025-06-29T19:12:35+05:30", // Event timestamp
"resource": "mandate",
"id": "01JYXYSV8B19XAWSFRPARXY35E", // Mandate ID
"status": "paused",
"reason": {
"code": "mandate-paused", // Reason code
"desc": "mandate is paused", // Reason description
"npciErrCode": "00", // NPCI error code
"npciErrDesc": "SUCCESS", // NPCI error code description
"npciErrCategory": "NA", // NPCI error category
"npciRespCode": "00", // NPCI response code
"npciRespDesc": "SUCCESS", // NPCI response code description
"setuDescription": "", // Setu description
"suggestedAction": "" // Suggested action
},
// Merchant and Reference Information
"merchantId": "01JYXYSV8B19XAWSFRPARXY35E", // Merchant ID
"merchantReferenceId": "mandate_123456789", // mandate referenceId
"txnId": "HDF10e4ab8a07f447eea54581383d92b507", // NPCI Txn.id
"txnTs": "2025-06-29T19:12:35+05:30", // NPCI Txn.ts
"rrn": "123456789012", // NPCI Txn.custRef
"umn": "c27f5fc30d344e9594fce0afa34f8859@mypsp", // Unique Mandate Number from NPCI
"mandateId": "01JYXYSV8B19XAWSFRPARXY35E", // Same as id field
// Amount Information
"amount": 1000, // Current mandate amount in paise
"amountLimit": 1000, // Current mandate amount in paise
"endDate": "20032025", // Current mandate end date in DDMMYYYY format
// TPV Specific Information (empty object for non-TPV mandates)
"customerAccount": { // Payer account details, empty object for non-TPV mandates
"encryptedAccountNumber": "fhDBZ4fC2RtNyiW5rB-jDnzzs_YpYwPGerwAwDTd", // Encrypted account number
"hashedAccountNumber": "d49f354241572a261cfd3a7f210f1919c79fa9993b29e34c5511c3ecefc9f3ea", // Hashed account number
"maskedAccountNumber": "**** **** **** 1234", // Masked account number
"hashedAccountName": "cceaad99aec841a21be45f02368d0d332493a5a62fdda20c3d85bfb617ef176b", // Hashed account name
"maskedAccountName": "M*N* T*O*M*A*S", // Masked account name
"encryptedAccountName": "n6MUSW1KXaSWh1E38zxhh1amv9E6rPmZ2Tw=", // Encrypted account name
"ifsc": "HDFC0000053", // IFSC code
"accountType": "SAVINGS" // Account type
}
}The following param values indicate this state—
operationwill bepauseeventTypewill bemandate_operation.pause.failedstatuswill befailed
{
"eventId": "1c94fdeb-2167-443d-99f4-f5fe21d079ae", // Unique event identifier, generated using UUID
"eventType": "mandate_operation.pause.failed",
"eventTs": "2025-06-29T19:12:35+05:30", // Event timestamp
"resource": "mandate_operation",
"id": "01JYXYSV8B19XAWSFRPARXY35E", // Mandate operation ID
"operation": "pause",
"status": "failed",
// Failure reason object
"reason": {
"code": "mandate-operation-failed", // Reason code
"desc": "INVALID / INCORRECT MPIN", // Reason description
"npciErrCode": "UM8", // NPCI error code
"npciErrDesc": "RESPMANDATE DECLINED BY REMITTER BANK", // NPCI error code description
"npciErrCategory": "BD", // NPCI error category
"npciRespCode": "ZM", // NPCI response code
"npciRespDesc": "INVALID / INCORRECT MPIN", // NPCI response code description
"setuDescription": "", // Setu description
"suggestedAction": "" // Suggested action for the user
},
// Merchant and Reference Information
"merchantId": "01JYXYSV8B19XAWSFRPARXY35E", // Merchant ID
"merchantReferenceId": "mandate_123456789", // mandate referenceId
"txnId": "HDF10e4ab8a07f447eea54581383d92b507", // NPCI Txn.id
"txnTs": "2025-06-29T19:12:35+05:30", // NPCI Txn.ts
"rrn": "123456789012", // NPCI Txn.custRef
"umn": "c27f5fc30d344e9594fce0afa34f8859@mypsp", // Unique Mandate Number from NPCI
"mandateId": "01JYXYSV8B19XAWSFRPARXY35E", // ID of the mandate being operated on
// Amount Information
"amount": 1000, // Current mandate amount in paise
"amountLimit": 1000, // Current mandate amount in paise
"endDate": "20032025", // Mandate end date in DDMMYYYY format
// TPV Specific Information (empty object for non-TPV mandates)
"customerAccount": { // Payer account details, empty object for non-TPV mandates
"encryptedAccountNumber": "fhDBZ4fC2RtNyiW5rB-jDnzzs_YpYwPGerwAwDTd", // Encrypted account number
"hashedAccountNumber": "d49f354241572a261cfd3a7f210f1919c79fa9993b29e34c5511c3ecefc9f3ea", // Hashed account number
"maskedAccountNumber": "**** **** **** 1234", // Masked account number
"hashedAccountName": "cceaad99aec841a21be45f02368d0d332493a5a62fdda20c3d85bfb617ef176b", // Hashed account name
"maskedAccountName": "M*J*O*H*N* D*O*E", // Masked account name
"encryptedAccountName": "n6MUSW1KXaSWh1E38zxhh1amv9E6rPmZ2Tw=", // Encrypted account name
"ifsc": "HDFC0000053", // IFSC code
"accountType": "SAVINGS" // Account type
}
}In addition to mandate_operation.pause.failed, a mandate status event is also sent to indicate current mandate status.