This API is used to initiate a pre-debit notification at least 24 hours before presenting the actual mandate.
Overview
This API triggers the pre-debit notification to the payer. It must be used at least 24 to 48 hours before the actual debit is initiated using the Mandate Presentation API.
Note: NPCI places the validation of 24 hours as part of the operating guidelines for UPI Autopay.
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 mandate ID from Decentro in the Get Mandate Status API or the Registration Callback.
- The platform passes the same in the 'decentro_mandate_id' field in the request payload on the endpoints.
- Decentro initiates a pre-debit notification with its bank partner and responds if there's any error.
- The payer receives a push notification from the UPI app and an SMS notification from Decentro's bank partner if there's no issue with the pre-debit notification request.
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 pre-debit request should be against an active mandate
- The pre-debit request should be as per the set frequency
- The pre-debit request should be as per the amount rule
- The pre-debit request should be as per the set date rule
If the pre-debit notification fails, the debit request will also fail since that's a pre-requisite as per NPCI operating guidelines.
API Endpoints
Environment | Endpoint |
---|---|
Staging / Sandbox | https://staging.api.decentro.tech/v3/payments/upi/autopay/mandate/notify |
Production | https://api.decentro.tech/v3/payments/upi/autopay/mandate/notify |
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 |