get
https://staging.api.decentro.tech/v3/payments/upi/autopay/mandate/status
This API is used to get the status of a mandate registration which was created using the Create Mandate API.
Overview
This API can be used to check the status of a mandate registration initiated by the Create Mandate API as an alternative to the Mandate Status Callback to fetch the details of a registered mandate.
Decentro supports fetching the status of a mandate registration using the decentro mandate ID provided by Decentro at the time of registration.
Flow
Below is the flow for using this API.
- The platform initiates the mandate registration request using the Create Mandate API.
- The payer authorizes the request on the UPI app using their MPIN.
- Decentro triggers the Registration callback to the platform's endpoint as configured with the registration status.
- Alternatively, the platform can check the status of mandate registration using the endpoints and the Decentro mandate ID received from the Create Mandate API.
Mandate Status
| Status | Description |
|---|---|
| Active | Mandate is successfully registered & in active state. These mandates can be used for presentations. |
| Revoked | Mandate is revoked/ cancelled. These mandates are not eligible for presentations. (Not in use) |
| Pending | Mandate registration link is created & no action is performed on the link yet. |
| Expired | Mandate registration link has expired as no action was taken by the user. If the user opens the link, the status update & callback may take up to 5 minutes. If the link is not accessed, the status change and callback happen immediately. |
| Completed | When mandate end date is passed or all scheduled presentations are completed. No further presentations allowed. |
| Rejected | When mandate registration is failed. |
| Paused | Mandate is paused by the end user. No presentations allowed during paused state. |
| Failed | When mandate registration is failed. |
| Cancelled | Mandate is revoked/ cancelled. These mandates are not eligible for presentations. |
API Endpoints
| Environment | Endpoint |
|---|---|
| Staging / Sandbox | https://staging.api.decentro.tech/v3/payments/upi/autopay/mandate/status |
| Production | https://api.decentro.tech/v3/payments/upi/autopay/mandate/status |