UPI Autopay - Mandate Management API

This API is used to manage the mandate. Merchants can perform the actions like cancel and update mandate.

Overview

The Mandate Management API allows merchants to manage existing UPI Autopay mandates.

Only mandates with statuses ACTIVE or PAUSED are eligible for cancellation/ update.

On successful cancellation, all scheduled executions and pre-debit notifications will be cancelled.

Merchants can update the end date of the mandate or amount of the mandate or both the values.

Mandates registered via Collect Request + Collect Request with TPV are eligible for modifying the mandates(Update API)

Allowed Mandate Statuses for Cancellation & Update:

  • ACTIVE
  • PAUSED

Any other status (e.g., CANCELLED, EXPIRED) will result in an error.

Body Params
string
required

Unique identifier passed at every request

string
required
Defaults to CANCEL

This param is used to define the type of action the API to perform. Accepted values are Cancel or Update.

string
required

This param will accept the decentro mandate id to perform the defined action.

update_fields
object
Headers
string
required

Decentro assigned client_id during on boarding.

string
required

Decentro assigned client_secret during on boarding.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json