This API is used to execute a registered UPI based mandate that is created using the Create Mandate API.
Overview
This API lets the platform execute a debit request against a registered mandate for whom the pre-debit notification has been successfully initiated.
This API is an async API and the actual debit happens after the request is placed by Decentro with the bank partner.
Flow
Below is the flow for using this API.
- The platform registers a UPI-based mandate using the Create Mandate API and receives the unique decentro mandate ID in the response from Decentro and in the Get Mandate Status API or the Registration Callback.
- The platform initiates the pre-debit notification using the Pre-debit Notification API by passing the unique decentro mandate ID from Decentro.
- Decentro responds with a presentation sequence ID upon successful completion of the notification.
- The platform passes the same in the request payload on the endpoints if the pre-debit notification is successful.
- The platform can also use decentro_mandate_id to trigger the presentation API within 5 minutes of registration. Pre-Debit notification is not required in case of instant presentation within 5 min
- Decentro triggers a Presentation Status Callback to a pre-configured endpoint once the presentation reaches a terminal stage.
- The platform can check the status of the mandate using the Mandate Presentation Status API as an alternative.
Points to Note
Decentro checks a few points before initiating the pre-debit request, most of which are fetched from the mandate registration details here.
- The debit request should be against an active mandate
- The debit request should be as per the set frequency
- The debit request should be as per the amount rule
- The debit request should be as per the set date rule
- The pre-debit notification request should be successful
- The user will receive a collect notification with expiry of 30 minutes in case presentation limit is more than the threshold limit. For most merchants, this limit is set to INR 15,000.
- The clients can retry the presentation after 1 hour from the previous presentation attempt.
- The clients can retry upto 9 times if a presentation is failed.
- This API is an async API
API Endpoints
Environment | Endpoint |
---|---|
Staging / Sandbox | https://staging.api.decentro.tech/v3/payments/upi/autopay/mandate/presentation |
Production | https://api.decentro.tech/v3/payments/upi/autopay/mandate/presentation |
Simulation Data
Decentro's simulation data helps developers simulate all the real-world scenarios when using the Create mandate API.
This requires the platform to use standard request payloads to handle scenarios for each API and scenario, as mentioned below.
The platform will need to whitelist their IP and configure callback endpoints with Decentro if they wish to handle the flow. Please reach out to us at support@decentro.tech for the same.
How to test?
Below is the flow to test the Simulation data
- Generate a mandate link by using Create Mandate API with the 'amount' parameter in the required range as mentioned in the test bed section.
- Click the generated link once before proceeding. This is a mandatory step to receive the simulation responses.
- Next Decentro will propagate the updated status of the mandate as per the amount (range) passed in step-1.
- Alternatively, client can use Get Mandate Status to fetch the latest status of the mandate.
- Next proceed to trigger the Pre Debit Notification API to test various scenario basis the amount range values mentioned in the respective test bed section.
- Next, proceed to trigger the Mandate Presentation API to test various scenarios basis the amount range values as mentioned in the respective test bed section.
- Note: The simulation environment is an exact replica of production environment including all the checks of production systems for registration, notification and, presentation .
Test Bed
Mandate Creation
Amount | Scenario |
---|---|
0 - 1000 | Mandate registration is successful. Mandate status is Active |
1001 - 2000 | Mandate registration is failed. Mandate status is Failed |
Pre Debit Notification
Amount | Scenario |
---|---|
0 - 500 | Pre debit notification is successful. |
501 - 600 | Pre debit notification failed |
Presentation
Amount | Scenario |
---|---|
0 - 100 | Mandate Presentation is successful. |
150 - 200 | Mandate Presentation failed |