This API allows the platform to check the status of a mandate presentation using Decentro's ENACH V3 stack.
Overview
This API allows the platform to check the status of a mandate executed using the Mandate Execution API, whether the mandate execution was successful or failed.
If this API is used before the execution is completed, the status of the execution would be 'Pending'. Subsequently, the execution status can move to Success or Failed as passed under the 'transactionStatus' field in the response.
Ensure to use only staging credentials.
Flow
Below is the flow for using this API.
- The platform registers a mandate successfully using the Mandate Registration API.
- The platform informs the payer about an upcoming debit through a standard mode of communication.
- The platform initiates the debit request using the endpoint.
- Decentro propagates the same to its bank partner & NPCI
- Decentro receives the status of the execution from its bank partner
- Decentro triggers the Execution Status Callback to the platform's pre-configured endpoint.
- Alternatively, the platform can use this API to check the status using the endpoint.
Execution Statuses
| Status | Description |
|---|---|
| Initiated | Mandate presentation has been initiated. |
| Pending | The mandate presentation file has been sent to NPCI, and a response from NPCI is pending. |
| Success | The amount has been successfully debited from the user's account. |
| Failure | NPCI has rejected the mandate presentation for various reasons. |
Please note that Decentro propagates the actual status of the debit under the 'transactionStatus' field in the response. The 'status' field in the response is the status of the API and not the actual transaction.
API Endpoints
| Environment | Endpoint |
|---|---|
| Staging / Sandbox | https://staging.api.decentro.tech/v3/payments/enach/mandate/execute/status |
| Production | https://api.decentro.tech/v3/payments/enach/mandate/execute/status |