UPI Setu

Notify

API Playground

Notifications and alerts for mandate pre-debit notify action

These are the available webhooks for merchants, when they notify their customers before mandate execution.

{
  "eventId": "1c94fdeb-2167-443d-99f4-f5fe21d079ae",  // Unique event identifier, generated using UUID
  "eventType": "mandate_operation.notify.initiated",  
  "eventTs": "2025-06-29T19:12:35+05:30",             // Event timestamp
  "resource": "mandate_operation",                    
  "id": "01JYXYSV8B19XAWSFRPARXY35E",                 // mandate pre-debit notification id
  "operation": "notify",                             
  "status": "initiated",                             
  "reason": {},                                       // Empty reason object for initiated status
  "merchantId": "01JYXYSV8B19XAWSFRPARXY35E",         // Merchant ID
  "merchantReferenceId": "mandate_123456789",         // mandate pre-debit notification referenceId
  "txnId": "HDF10e4ab8a07f447eea54581383d92b507",     // NPCI Txn.id
  "umn": "c27f5fc30d344e9594fce0afa34f8859@mypsp",    // Unique Mandate Number from NPCI
  "mandateId": "01JYXYSV8B19XAWSFRPARXY35E",          // ID of the mandate being operated on
  "amount": 1000,                                     // Amount in paise
  "seqNum": "1"                                       // Sequence number for the notification
}
{
  "eventId": "1c94fdeb-2167-443d-99f4-f5fe21d079ae",  // Unique event identifier, generated using UUID
  "eventType": "mandate_operation.notify.success",    
  "eventTs": "2025-06-29T19:12:35+05:30",             // Event timestamp
  "resource": "mandate_operation",                    
  "id": "01JYXYSV8B19XAWSFRPARXY35E",                 // Mandate pre-debit notification id
  "operation": "notify",                             
  "status": "success",                               
  "reason": {
    "code": "mandate-notification-success",           // Reason code
    "desc": "mandate notification 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
  },
  "merchantId": "01JYXYSV8B19XAWSFRPARXY35E",         // Merchant ID
  "merchantReferenceId": "mandate_123456789",         // mandate pre-debit notification referenceId
  "txnId": "HDF10e4ab8a07f447eea54581383d92b507",     // NPCI Txn.id
  "umn": "c27f5fc30d344e9594fce0afa34f8859@mypsp",    // Unique Mandate Number from NPCI
  "mandateId": "01JYXYSV8B19XAWSFRPARXY35E",          // ID of the mandate being operated on
  "amount": 1000,                                     // Amount in paise
  "seqNum": "1"                                       // Sequence number for the notification
}
{
  "eventId": "1c94fdeb-2167-443d-99f4-f5fe21d079ae",  // Unique event identifier, generated using UUID
  "eventType": "mandate_operation.notify.failed",    
  "eventTs": "2025-06-29T19:12:35+05:30",             // Event timestamp
  "resource": "mandate_operation",                    
  "id": "01JYXYSV8B19XAWSFRPARXY35E",                 // Mandate pre-debit notification id
  "operation": "notify",                             
  "status": "failed",                               
  "reason": {
    "code": "mandate-notification-failed",            // Reason code
    "desc": "INVALID VIRTUAL ADDRESS",                // Reason description
    "npciErrCode": "UC5",                             // NPCI error code
    "npciErrDesc": "No response for ReqValCust",      // NPCI error code description
    "npciErrCategory": "BD",                          // NPCI error category
    "npciRespCode": "ZH",                             // NPCI response code
    "npciRespDesc": "INVALID VIRTUAL ADDRESS",        // NPCI response code description
    "setuDescription": "",                            // Setu description
    "suggestedAction": ""                             // Suggested action
  },
  "merchantId": "01JYXYSV8B19XAWSFRPARXY35E",         // Merchant ID
  "merchantReferenceId": "mandate_123456789",         // mandate pre-debit notification referenceId
  "txnId": "HDF10e4ab8a07f447eea54581383d92b507",     // NPCI Txn.id
  "umn": "c27f5fc30d344e9594fce0afa34f8859@mypsp",    // Unique Mandate Number from NPCI
  "mandateId": "01JYXYSV8B19XAWSFRPARXY35E",          // ID of the mandate being operated on
  "amount": 1000,                                     // Amount in paise
  "seqNum": "1"                                       // Sequence number for the notification
}

On this page