Skip to content

fix(UPI-2450): fix UPI Setu notification payloads #305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anindya-setu merged 1 commit into from
Jul 1, 2025
Merged

fix(UPI-2450): fix UPI Setu notification payloads #305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/payments/umap/mandates/generic/pause.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ When a customer initiates pausing a mandate from their UPI app, UPI Setu will se
<code>mandate_operation.pause.failed</code>, &nbsp; if pause fails
</Text>
- <Text>
<code>mandate.live</code>, &nbsp; terminal status, if pause fails
<code>A mandate status notification</code> to indicate current mandate status, &nbsp;if mandate pause fails (Example: mandate.live if mandate is in live state)
</Text>

Read more about <a href="/payments/umap/notifications/mandates" target="_blank">mandate status notifications </a> and <a href="/payments/umap/notifications/mandates/pause" target="_blank">mandate pause operation notifications</a>.
Expand Down
4 changes: 2 additions & 2 deletions content/payments/umap/mandates/generic/revoke.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ webhooks for following events
<code>mandate_operation.revoke.failed</code>,&nbsp;if mandate revoke fails
</Text>
- <Text>
<code>mandate.live</code>,&nbsp;if mandate revoke fails
<code>A mandate status notification</code> to indicate current mandate status, &nbsp;if mandate revoke fails (Example: mandate.live if mandate is in live state)
</Text>

<p>
Expand Down Expand Up @@ -172,7 +172,7 @@ following events:
<b>mandate_operation.revoke.success</b> (if mandate revoke is successful)
</li>
<li>
<b>mandate.live</b> (if mandate revoke fails)
<b>A mandate status notification to indicate current mandate status</b> (if mandate revoke fails) (Example: mandate.live if mandate is in live state)
</li>
<li>
<b>mandate_operation.revoke.failed</b> (if mandate revoke fails)
Expand Down
2 changes: 1 addition & 1 deletion content/payments/umap/mandates/generic/unpause.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Only the end customer has the option of unpausing a paused UPI mandate from thei
<b>mandate_operation.unpause.success</b> (if mandate unpause is successful)
</li>
<li>
<b>mandate.paused</b> (if mandate unpause fails)
<b>A mandate status notification to indicate current mandate status</b> (if mandate unpause fails) (Example: mandate.paused if mandate is in paused state)
</li>
<li>
<b>mandate_operation.unpause.failed</b> (if mandate unpause fails)
Expand Down
4 changes: 2 additions & 2 deletions content/payments/umap/mandates/generic/update.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ There are only two updates possible on a UPI mandate
successful)
</li>
<li>
<b>mandate.live</b> (if mandate update fails)
<b>A mandate status notification to indicate current mandate status</b> (if mandate update fails) (Example: mandate.live if mandate is in live state)
</li>
<li>
<b>mandate_operation.update.failed</b> (if mandate update fails)
Expand Down Expand Up @@ -268,7 +268,7 @@ There are only two updates possible on a UPI mandate
successful)
</li>
<li>
<b>mandate.live</b> (if mandate update fails)
<b>A mandate status notification to indicate current mandate status</b> (if mandate update fails) (Example: mandate.live if mandate is in live state)
</li>
<li>
<b>mandate_operation.update.failed</b> (if mandate update fails)
Expand Down
7 changes: 2 additions & 5 deletions content/payments/umap/notifications/mandates.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ A quick summary of the general statuses associated with a mandate—
</li>
<li>
<code>mandate.live</code> Customer has authorised the mandate, and the
mandate is active
mandate is active. Or the customer has unpaused a paused mandate and the
mandate is active again
</li>
<li>
<code>mandate.rejected</code> The mandate could not be set up, due to some
Expand All @@ -47,10 +48,6 @@ A quick summary of the general statuses associated with a mandate—
<code>mandate.paused</code> The customer has decided to pause executions
for mandate, which can be temporary
</li>
<li>
<code>mandate.unpaused</code> The customer has decided to unpause
executions for mandate, and mandate is active again
</li>
<li>
<code>mandate.revoked</code> The customer has decided to stop executions
for mandate before its expiry—this is a permanent action, and payments
Expand Down
368 changes: 172 additions & 196 deletions content/payments/umap/notifications/mandates/create.mdx
View file
Open in desktop

Large diffs are not rendered by default.

20 changes: 7 additions & 13 deletions content/payments/umap/notifications/mandates/execute.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,13 @@ These are the available webhooks for merchants, when they execute mandates being
"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": "customer@bank", // Unique Mandate Number from NPCI
"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
Expand All @@ -43,7 +41,7 @@ These are the available webhooks for merchants, when they execute mandates being
"txnId": "HDF10e4ab8a07f447eea54581383d92b507", // NPCI Txn.id
"paymentId": "01JYXYSV8B19XAWSFRPARXY35E", // payment id
"rrn": "123456789012", // NPCI Txn.custRef
"customerVpa": "customer@bank", // Customer's VPA
"customerVpa": "9650974246@ybl", // Customer's VPA
"paymentStatus": "initiated", // Status of the payment
"customerAccountType": "SAVINGS" // Payer account type
}
Expand All @@ -66,7 +64,6 @@ These are the available webhooks for merchants, when they execute mandates being
"id": "01JYXYSV8B19XAWSFRPARXY35E", // Mandate execution ID
"operation": "execute",
"status": "success",

// Success reason object
"reason": {
"code": "mandate-execution-success", // Reason code
Expand All @@ -79,12 +76,11 @@ These are the available webhooks for merchants, when they execute mandates being
"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": "customer@bank", // Unique Mandate Number from NPCI
"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
Expand All @@ -94,7 +90,7 @@ These are the available webhooks for merchants, when they execute mandates being
"txnId": "HDF10e4ab8a07f447eea54581383d92b507", // NPCI Txn.id
"paymentId": "01JYXYSV8B19XAWSFRPARXY35E", // payment id
"rrn": "123456789012", // NPCI Txn.custRef
"customerVpa": "customer@bank", // Customer's VPA
"customerVpa": "9650974246@ybl", // Customer's VPA
"paymentStatus": "success", // Status of the payment
"customerAccountType": "SAVINGS" // Payer account type
}
Expand All @@ -121,25 +117,23 @@ These are the available webhooks for merchants, when they execute mandates being
"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
"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": "customer@bank", // Unique Mandate Number from NPCI
"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
Expand All @@ -149,7 +143,7 @@ These are the available webhooks for merchants, when they execute mandates being
"txnId": "HDF10e4ab8a07f447eea54581383d92b507", // NPCI Txn.id
"paymentId": "01JYXYSV8B19XAWSFRPARXY35E", // payment id
"rrn": "123456789012", // NPCI Txn.custRef
"customerVpa": "customer@bank", // Customer's VPA
"customerVpa": "9650974246@ybl", // Customer's VPA
"paymentStatus": "failed", // Status of the payment
"customerAccountType": "SAVINGS" // Payer account type
}
Expand Down
18 changes: 4 additions & 14 deletions content/payments/umap/notifications/mandates/notify.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,11 @@ These are the available webhooks for merchants, when they notify their customers
"id": "01JYXYSV8B19XAWSFRPARXY35E", // mandate pre-debit notification id
"operation": "notify",
"status": "initiated",

// Empty reason object for initiated status
"reason": {},

// Merchant and Reference Information
"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": "customer@bank", // Unique Mandate Number from NPCI
"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
Expand All @@ -56,7 +52,6 @@ These are the available webhooks for merchants, when they notify their customers
"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
Expand All @@ -68,12 +63,10 @@ These are the available webhooks for merchants, when they notify their customers
"setuDescription": "", // Setu description
"suggestedAction": "" // Suggested action
},

// Merchant and Reference Information
"merchantId": "01JYXYSV8B19XAWSFRPARXY35E", // Merchant ID
"merchantReferenceId": "mandate_123456789", // mandate pre-debit notification referenceId
"txnId": "HDF10e4ab8a07f447eea54581383d92b507", // NPCI Txn.id
"umn": "customer@bank", // Unique Mandate Number from NPCI
"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
Expand All @@ -96,7 +89,6 @@ These are the available webhooks for merchants, when they notify their customers
"id": "01JYXYSV8B19XAWSFRPARXY35E", // Mandate pre-debit notification id
"operation": "notify",
"status": "failed",

"reason": {
"code": "mandate-notification-failed", // Reason code
"desc": "INVALID VIRTUAL ADDRESS", // Reason description
Expand All @@ -108,12 +100,10 @@ These are the available webhooks for merchants, when they notify their customers
"setuDescription": "", // Setu description
"suggestedAction": "" // Suggested action
},

// Merchant and Reference Information
"merchantId": "01JYXYSV8B19XAWSFRPARXY35E", // Merchant ID
"merchantReferenceId": "mandate_123456789", // mandate pre-debit notification referenceId
"txnId": "HDF10e4ab8a07f447eea54581383d92b507", // NPCI Txn.id
"umn": "customer@bank", // Unique Mandate Number from NPCI
"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
Expand Down
Loading