UPI Autopay - Mandate Status Callback

post

https://your.custom.endpoint.com/upi_registration_status

This callback is triggered by Decentro to the platform when the customer approves the mandate request on the PSP app.

Overview

Decentro triggers this callback to a pre-configured endpoint after the payer authorizes the mandate registration request on their UPI app or if the registration expires.

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 initiates the mandate registration request using the Create Mandate API.
The payer authorizes the request on the UPI app using their MPIN.
Decentro triggers this callback to the platform's endpoint as configured with the registration status if authorized.
The platform can reconcile the registration request using the reference_id or decentro_mandate_id parameters passed in the Create Mandate API.
The platform can also check the registration status using the Get Mandate Status API.

Decentro triggers the callback for the below scenarios.

Successful registration of a mandate
Unsuccessful registration of a mandate
Expiry of the mandate request
Pause, unpause, revoke or update actions on a mandate
Completion of the mandate

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 is expired. No action is performed on the link by the user.
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://your.custom.endpoint.com
Production	https://your.custom.endpoint.com

Body Params

mandate_status

string

required

Status of the mandate

mandate_status_description

string

The description of the status of the mandate.

mandate_attempt_status

string

The status of the registration attempt of the mandate.

mandate_attempt_status_description

string

The description of the status of the registration attempt of the mandate.

decentro_txn_id

string

The unique decentro Txn Id received during mandate creation.

callback_attempt

int32

The number of times the callback is attempted

callback_timestamp

string

The timestamp of the callback

consumer_urn

string

The URN of the entity against which the mandate was registered.

reference_id

string

The reference ID passed by the platform at the time of execution

mandate_creation_timestamp

string

The timestamp when the mandate was created

bank_reference_number

string

Reference number for the registration

payer_vpa

string

UPI handle against which the mandate is registered

decentro_mandate_id

string

Unique decentro mandate ID assigned for each mandate.

amount

string

Mandate registration amount

amount_rule

string

Amount rule as defined at the time of mandate creation

payer_name

string

Payer name against whom the mandate is registered

payee_name

string

The Name of the of the sub-merchant onboarded account

next_debit_date

string

Next debit date. Applicable if frequency is not ASPRESENTED

mandate_name

string

Name of the mandate holder as passed during mandate creation

frequency

string

Mandate registration frequency

start_date

string

Mandate start date

end_date

string

Mandate end date

presentation_summary

object

The summary of all presentation count

rule_type

string

The rule type of the mandate as passed during mandate creation

block_fund

string

Blocking the funds during the debit presentation. Only true to selceted merchants.

is_revocable

string

The flag denotes whether the end user will be able to revoke a mandate.

last_action

string

The last action performed on the mandate. Example: CREATE, UPDATE, PAUSE

last_action_timestamp

string

The timestamp when the last action of performed on the mandate.

last_action_auth_timestamp

string

The authentication timestamp when the last action was performed on the mandate.

npci_transaction_id

string

The NPCI txn ID of the mandate registration

original_callback_txn_id

string

Original Callback ID. Shared in case of retries only

callback_txn_id

string

Callback ID provided by Decentro

Headers

your_custom_key_1

string

The header token shared by you should not contain any unsanitized values like @ # $ % ^ & * ! ; : ' " ~ ` ? = + ) (

your_custom_key_2

string

The header token shared by you should not contain any unsanitized values like @ # $ % ^ & * ! ; : ' " ~ ` ? = + ) (

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Overview

Flow

Mandate Status

API Endpoints

200200

401401