Overview

This API allows the platform to initiate an UPI-based mandate registration request. The payer can then authorize the request using one of the supported flows.

Intent flow: in this flow, the platform doesn't need to have the payer's VPA. Decentro validates the request and the payer can pay using any supported UPI app on their mobile device. Suitable for mobile apps.
QR flow: in this flow, the platform doesn't need to have the payer's VPA. Decentro generates a QR code and the payer can pay using any supported UPI app on their mobile device. Suitable for latops and web views.
Collect flow: in this flow, the platform needs to have the payer's VPA handy. Decentro validates the VPA and triggers the request if the VPA is valid. Suitable for latops and web views.

Flow

Below is the intent flow for using this API.

The platform captures the mandate details like amount, frequency, timeframe, etc. at their end
The platform passes the same in this API against the endpoints
The platform receives a shortened link that can be displayed on the platform's app
The payer can choose the app of their choice as available on their app
The payer authorizes the request by using the UPI MPIN

Below is the collect flow for using this API.

The platform captures the mandate details like amount, frequency, timeframe, etc. at their end
The platform passes the same in this API against the endpoints
Decentro validates if the VPA is supported in case of collect flow
The payer receives a notification from their UPI app where the VPA is available
The payer navigates to the app where the VPA is registered
The payer authorizes the request by using the UPI MPIN

Below is the common flow after the payer authorizes the request.

The platform receives the Registration callback to a pre-configured endpoint
The platform receives the status of mandate registration in the callback itself
Alternatively, the platform can check the status using the Mandate Status API

Request Parameters

Frequency

Below are the parameters accepted under the 'frequency' field in the request body and their interpretation.

Value	Description
Daily	The mandate can be presented daily.
Weekly	The mandate can be presented weekly on a specific day of the week
Fortnightly	The mandate can be presented once every 2 weeks from the start date
Monthly	The mandate can be presented once a month on a specific date of the month
Quarterly	The mandate can be presented once a quarter from the start date
Half Yearly	The mandate can be presented once every 6 months from the start date
Yearly	The mandate can be presented once every 12 months from the start date
Onetime	The mandate can be presented only once before the end date
Adhoc	The mandate can be presented as needed

Rule Type

Below are the parameters accepted under the 'rule_type'field in the request body and their interpretation.

Value	Description
On	The mandate can be presented on the exact date
Before	The mandate can be presented before the due date as long as frequency is maintained
After	The mandate can be presented after the due date as long as frequency is maintained

Amount Rule

Below are the parameters accepted under the 'amount_rule'field in the request body and their interpretation.

Value	Description
Max	The amount registered is the maximum that can be debited. Any presentation amount lesser than the amount that can be presented
Exact	The amount registered is the exact amount that can be debited. Any presentation amount

API Endpoints

Below are the API endpoints to be used by the platform basis the environments.

Environment	Endpoint
Staging / Sandbox	https://in.staging.decentro.tech/v2/payments/upi/autopay/mandate
Production	https://in.decentro.tech/v2/payments/upi/autopay/mandate