get https://staging.api.decentro.tech/v3/payments/enach/mandate/status
This API allows the platform to check the status of a mandate registration using Decentro's ENACH V3 stack.
Overview
Decentro allows the platform to check the status of mandate registration initiated through Registration API. This is in addition to the Registration Status Callback triggered by Decentro when the payer completes the registration authorization.
Ensure to use only staging credentials.
Flow
Below is the flow for this API.
- The payer is redirected from the link passed in the Registration API.
- Decentro propagates the Decentro transaction ID as part of the response payload.
- After the payer has authorized the request, Decentro triggers the Registration status callback and redirects the payer to the platform's page.
- Alternatively, the platform can check the status using the Registration Status API by passing the Decentro transaction ID passed by Decentro in the response payload.
Decentro propagates the registration status as PENDING if the payer does not complete the authorization or the payer drops off in the journey.
Registration Statuses
| Status | Description |
|---|---|
| Registered | Represents a mandate that has been successfully registered but is not yet active because the start date is in the future. |
| Active | Mandate registration has been successfully completed, and the mandate is currently active. |
| Inactive | The mandate registration end date has passed. |
| Pending | The mandate registration is still pending. The registration process has been initiated with all user details but not yet completed. |
| Rejected | Mandate is rejected by destination banks or NPCI for various reasons. |
| Expired | The mandate registration link has expired. This status occurs when the user fails to initiate or open the registration link within the specified timeframe. |
| Initiated | The mandate registration process is initiated. Few mandatory details are yet to be collected by the user. |
| Session_Timeout | The user initiated the registration session by clicking on the registration link but did not complete the process. The registration was dropped mid-journey due to inactivity or other reasons. |
| Session_Cancelled | The user initiated the registration session of UIStreams & then cancelled the registration flow in user details collection form. |
API Endpoints
Below are the API endpoints to be used by the platform basis the environments.
| Environment | Endpoint |
|---|---|
| Staging / Sandbox | https://staging.api.decentro.tech/v3/payments/enach/mandate/status |
| Production | https://api.decentro.tech/v3/payments/enach/mandate/status |