UPI Autopay - Mandate Presentation Callback

post

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

This callback is triggered by Decentro to the platform when a debit request is executed

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

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

Body Params

presentation_status

string

Debit status of the presentation

presentation_status_description

string

Description of the debit status of the presentation. Failure reason will be found here

presentation_sequence_id

string

The presentation sequence ID of the presentation cycle

remaining_representation_attempts

int32

The number of retry attempts pending for a failed presentation attempt in a given presentation cycle. Max retries: 9

presentation_auth_timestamp

string

The user authentication timestamp of presentation collect request in case amount is more than the threshold.

decentro_txn_id

string

The decentro Txn ID of the presentation

callback_attempt

int32

The number of times the callback is attempted

callback_txn_id

string

Callback ID provided by Decentro

consumer_urn

string

required

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

callback_timestamp

string

The timestamp of the callback

original_callback_txn_id

string

Original Callback ID. Shared in case of retries only

reference_id

string

required

The reference ID passed by the platform at the time of Presentation API. For instant presentations, Reference ID will be mapped to Create Mandate APIs reference_id

bank_reference_number

string

Reference number for the presentation

npci_txn_id

string

The NPCI txn ID of the presentation.

payer_vpa

string

UPI handle against which the funds are deducted.

decentro_mandate_id

string

Unique decentro mandate ID assigned for each mandate.

amount

double

Mandate registration amount

amount_rule

string

Amount rule as defined at the time of registration

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

date

Next debit date. Applicable if frequency is not ASPRESENTED

mandate_name

string

Name of the mandate holder as passed during registration

frequency

string

Mandate registration frequency

start_date

date

Mandate start date

end_date

date

Mandate end date

presentation_summary

object

Summary of presentation counts

rule_type

string

The rule type of the mandate as passed during registration

block_fund

boolean

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.

error_key

string

Defaults to error_at_remitter_bank

Presentation failure reason bucketing.

error_key_description

string

NPCI error code & reason for failure

Headers

your_custom_header_key_1

string

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

your_custom_header_key_2

string

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

Response

Language

Response

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

application/json

Overview

Flow

API Endpoints

200200