UPI Setu

Execute

API Playground

Notifications and alerts for mandate execution

These are the available webhooks for merchants, when they execute mandates being registered through UPI Setu.

{
  "eventId": "1c94fdeb-2167-443d-99f4-f5fe21d079ae",  // Unique event identifier, generated using UUID
  "eventType": "mandate_operation.execute.initiated", 
  "eventTs": "2025-06-29T19:12:35+05:30",             // Event timestamp
  "resource": "mandate_operation",                    
  "id": "01JYXYSV8B19XAWSFRPARXY35E",                 // Mandate execution ID
  "operation": "execute",                            
  "status": "initiated",                             
  // Empty reason object for initiated status
  "reason": {},
  // Merchant and Reference Information
  "merchantId": "01JYXYSV8B19XAWSFRPARXY35E",         // merchant ID
  "merchantReferenceId": "mandate_123456789",         // mandate execution reference ID
  "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 execution
  "blockedAmount": 10000,                             // Amount blocked for multi-debit mandates
  "debitedAmount": 1000,                              // Total amount debited for multi-debit mandates
  "payment": {                                        // Payment details for this execution
    "txnId": "HDF10e4ab8a07f447eea54581383d92b507",   // NPCI Txn.id
    "paymentId": "01JYXYSV8B19XAWSFRPARXY35E",        // payment id
    "rrn": "123456789012",                            // NPCI Txn.custRef
    "customerVpa": "9650974246@ybl",                  // Customer's VPA
    "paymentStatus": "initiated",                     // Status of the payment
    "customerAccountType": "SAVINGS"                  // Payer account type
  }
}
{
  "eventId": "1c94fdeb-2167-443d-99f4-f5fe21d079ae",  // Unique event identifier, generated using UUID
  "eventType": "mandate_operation.execute.success",    
  "eventTs": "2025-06-29T19:12:35+05:30",             // Event timestamp
  "resource": "mandate_operation",                    
  "id": "01JYXYSV8B19XAWSFRPARXY35E",                 // Mandate execution ID
  "operation": "execute",                             
  "status": "success",                                
  // Success reason object
  "reason": {
    "code": "mandate-execution-success",              // Reason code
    "desc": "mandate execution 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 execution 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 execution
  "blockedAmount": 10000,                             // Amount blocked for multi-debit mandates
  "debitedAmount": 1000,                              // Total amount debited for multi-debit mandates
  "payment": {                                        // Payment details for this execution
    "txnId": "HDF10e4ab8a07f447eea54581383d92b507",   // NPCI Txn.id
    "paymentId": "01JYXYSV8B19XAWSFRPARXY35E",        // payment id
    "rrn": "123456789012",                            // NPCI Txn.custRef
    "customerVpa": "9650974246@ybl",                  // Customer's VPA
    "paymentStatus": "success",                       // Status of the payment
    "customerAccountType": "SAVINGS"                  // Payer account type
  }
}

This is sent if mandate could not be created, due to some error or no authorisation from customer.

{
  "eventId": "1c94fdeb-2167-443d-99f4-f5fe21d079ae",  // Unique event identifier, generated using UUID
  "eventType": "mandate_operation.execute.failed",    
  "eventTs": "2025-06-29T19:12:35+05:30",             // Event timestamp
  "resource": "mandate_operation",                    
  "id": "01JYXYSV8B19XAWSFRPARXY35E",                 // Mandate execution ID
  "operation": "execute",                            
  "status": "failed",                                
  // Failure reason object
  "reason": {
    "code": "mandate-execution-failed",               // Reason code
    "desc": "INVALID / INCORRECT MPIN",               // Reason description
    "npciErrCode": "U30",                             // NPCI error code
    "npciErrDesc": "DEBIT HAS BEEN FAILED",           // 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
  },
  // Merchant and Reference Information
  "merchantId": "01JYXYSV8B19XAWSFRPARXY35E",         // merchant ID
  "merchantReferenceId": "mandate_123456789",         // mandate execution 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 execution
  "blockedAmount": 10000,                             // Amount blocked for multi-debit mandates
  "debitedAmount": 1000,                              // Total amount debited for multi-debit mandates
  "payment": {                                        // Payment details for this execution
    "txnId": "HDF10e4ab8a07f447eea54581383d92b507",   // NPCI Txn.id
    "paymentId": "01JYXYSV8B19XAWSFRPARXY35E",        // payment id
    "rrn": "123456789012",                            // NPCI Txn.custRef
    "customerVpa": "9650974246@ybl",                  // Customer's VPA
    "paymentStatus": "failed",                        // Status of the payment
    "customerAccountType": "SAVINGS"                  // Payer account type
  }
}

On this page