This API allows the platform to initiate a presentation using Decentro's ENACH V3 stack.
Overview
This API allows the platform to initiate an execution request (debit from the payer's account) against a registered mandate. The platform can initiate the debit request using the decentro_mandate_id, which Decentro propagates in the Mandate Registration API if mandate registration is successful.
Please note that this API doesn't assure the funds will be debited. That would depend on the funds available in the payer's bank account, and the status is propagated asynchronously by Decentro to the platform.
Ensure to use only staging credentials & Simulation data only.
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 endpoints.
- Decentro propagates the same to its bank partner & NPCI
- Basis the presentation timeline, the payer's bank account is debited
- Decentro receives intimation about the status of the execution from its bank partner
- Decentro intimates the same to the platform using theMandate Execution Callback a pre-configured endpoint.
- Execution callbacks will be sent within 24 hours post-initiation.
- The platform can also use the Mandate Execution Status API to check the execution status.
Decentro checks if the said mandate is registered and active. If the mandate is not found due to an invalid UMRN or if the mandate is not registered, Decentro fails the request itself
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. |
Request Parameters
Below are the request parameters the platform passed to Decentro in this API.
- reference_id: This parameter is used to reconcile an API hit uniquely
- transaction_reference: This parameter is used to pass the platform's unique mandate identifier, such as a loan account number, etc.
- decentro_mandate_id: This is a unique ID that Decentro passes at the time of registration to the platform if a mandate is successfully registered.
- debit_date: This is when the actual debit must happen from the payer's bank account and must be on the same day or after that.
- amount: This is the amount that needs to be debited from the payer's bank account. The amount needs to be less than or equal to the registration amount.
API Endpoints
Environment | Endpoint |
---|---|
Staging / Sandbox | https://staging.api.decentro.tech/v3/payments/enach/mandate/execute |
Production | https://api.decentro.tech/v3/payments/enach/mandate/execute |
Simulation Data
Ensure to use UMRN generated from Mandate Registration API.
Amount | Scenario | Description |
---|---|---|
200 | Failure | The mandate execution failed. This could be due to multiple reasons. |
500 | Success | The mandate was executed successfully, and the amount was debited. |
Random Amount | Success | The mandate was executed successfully, and the amount was debited. |
In the staging environment, execution callbacks will be sent within 1 hour of the execution API call.