Pause
Pausing a mandate
PREREQUISITES
🌟 UPI mandates generic operations ↗Only customers can pause a UPI mandate from their UPI app.
When a customer initiates pausing a mandate from their UPI app, UPI Setu will send notifications to the merchant for following events—
-
mandate_operation.pause.initiated -
mandate_operation.pause.success, if pause is successful -
mandate.paused, terminal status, if pause is successful -
mandate_operation.pause.failed, if pause fails -
A mandate status notificationto indicate current mandate status, if mandate pause fails (Example: mandate.live if mandate is in live state)
Read more about mandate status notifications and mandate pause operation notifications.
The notifications are depicted in the below diagram—
After receiving mandate_operation.pause.initiated notification, a merchant can also use the check mandate operation status API to check if mandate pause is successful.
The only operation that can be performed on a paused mandate is to unpause it. Other operations like pre-debit notification, execution, update and revoke are blocked when a mandate is paused.
Check mandate operation status (optional)
Once notified on the mandate pause request, merchants can use this API to check its status.
| Staging host | https://umap.setu.co/api |
|---|---|
| Method | GET |
| Path | /v1/merchants/mandate-operations/{id} |
| Header |
|
Sample response
{
"amountLimit": 1000,
"createdAt": "2023-09-04T12:08:20+0530",
"endDate": "02012006",
"expireAfter": 120,
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"mandateId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"merchantId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"merchantReferenceId": "ABC1234789",
"mode": "collect",
"status": "success",
"txnId": "BTTZrc5gDFkuCr3n3I0ey4aNtzLOLR7K7aR",
"type": "pause",
"umn": "c27f5fc30d344e9594fce0afa34f8859@mypsp"
}In the above response id is a unique ID associated with this mandate pause request and can be used to track it later.
To know more about all the API params, please refer to the API documentation.