Overview

Decentro triggers this callback to a pre-configured endpoint after a mandate is executed using the Execute Mandate API. The status of the debit itself could be success or failure.

The platform can have the callback endpoints whitelisted by dropping a mail to [email protected].

Flow

Below is the flow for using this callback.

The platform presents the mandate using the Execute Mandate API.
Decentro presents the same to its bank partner and the funds might be debited from the payer's bank account mapped to the VPA against which the mandate is registered.
Decentro triggers this callback to the configured endpoints of the platform as soon as a terminal status (Success/Failure) is received
The platform can alternatively check the satus of the debit using the Get Mandate Execution Status API.

Decentro triggers the callback for the below scenarios.

Successful execution and the funds being debited from the payer's bank account
Unsuccessful execution and the funds not being debited from the payer's bank account

Request Parameters

Below are the parameters that Decentro passes in the callback.

Parameter	Description
decentro_mandate_urn	A unique URN passed by Decentro for each mandate registration request
mandate_status	The status of mandate registration. Values: Success, Failure, Expired
transaction_status	The status of callback. Values: Success, Failure
mandate_bank_reference_number	The unique transaction ID generated by Decentro's bank partner, if the payer has authorized the request, is not shared if the registration expires.
transaction_bank_reference_number	The unique transaction ID generated by NPCI
name	The name of the mandate as passed during the registration request
amount	The amount for the mandate registration as passed during the creation of the registration request
frequency	The frequency for the mandate registration as passed during the creation of the registration request as mentioned here
start_date	The start date of the mandate as passed during the creation of the registration request
end_date	The end date of the mandate as passed during the creation of the registration request
is_revokeable	A flag denoting if the mandate can be revoked by the payer or not.
payer_upi	The VPA (UPI ID) of the mandate holder, which is passed only if the payer has authorized the request
payer_name	The name of the mandate holder, which is passed only if the payer has authorized the request
payer_account_number	The underlying account number of the mandate holder, if passed by the bank partner
payee_upi	The VPA (UPI ID) of the merchant against whom the mandate registration has been initiated
payee_name	The name of the merchant against whom the mandate registration has been initiated
payee_ifsc	The IFSC code of the virtual account allocated to the merchant by Decentro at the time of onboarding
payee_account_number	The virtual account number allocated to the merchant by Decentro at the time of onboarding
amount_rule	The rule defining the amount passed in mandate registration as mentioned here
total_number_of_debits	The total number of debits that have been executed
remaining_debits	The pending debits basis the mandate registration parameters like frequency, amount_rule, etc.
unique_mandate_number	A unique mandate reference ID that NPCI passes and to be used downstream for pre-debit and execution if the payer has authorized the registration
next_debit_date	The next scheduled debit date as per the mandate registration parameters like frequency, amount_rule, etc.
timestamp	The timestamp of the execution
attempt	The attempt number of this callback.
callbackTxnId	A unique ID assigned by Decentro for this callback
originalCallbackTxnId	The callbackTxnId is passed by Decentro if the callback is retried. Else same value as callbackTxnId
callbackType	The type of callback with default value as : Mandate_Registration
reference_id	The reference ID passed by the platform at the time of execution.
decentro_txn_id	The reference ID passed by Decentro at the time of execution.

API Endpoints

Below are the API endpoints that can be configured by Decentro for receiving the callbacks.

Environment	Endpoint
Staging / Sandbox	https://your.custom.endpoint.com
Production	https://your.custom.endpoint.com