v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

Enach Mandate Registration

This API allows the platform to initiate a mandate registration using Decentro's ENACH V3 stack.

post/v3/payments/enach/mandate

Headers

client_idstring required

client_secretstring required

x_on_behalf_ofstring

Optional header that allows parent merchant to consume the API on behalf of sub-merchant.

authorizationstring

Customers can generate JWT using our Auth API with various grant types in the request body. JWT is valid for 15minutes.

Request body

reference_idstring required

A specific unique ID assigned by the platform for the API hit.

consumer_urnstring required

Unique ID assigned to the consumer.

start_datestring date required

Mandate start date

end_datestring date required

Mandate end date

amountnumber float required

Mandate Amount. Maximum : 1 CR (1,00,00,000)

amount_rulestring required

Rule of Amount (FIXED or MAX)

category_codestring required

Category Code as mentioned in the Category Code section

frequencystring required

Frequency of the Mandate. Fixed (one-time, adhoc, intra-day, daily, weekly, monthly, quaterly, semi-annually, yearly, bi-monthly)

redirection_urlstring

URL accepts both web url & deeplinks

authentication_modestring

Type of authentication to register the mandate. Should be passed only if "uistreams" flag is set as false. Accepted values are aadhaar, netbanking, pan, customerid & debitcard.

uistreamstring

To enable the UI based solution, pass the value as true.

Response

200

decentro_txn_idstring

api_statusstring

messagestring

response_keystring

Example response

{
  "api_status": "SUCCESS",
  "message": "Successfully initiated mandate registration.",
  "data": {
    "decentro_mandate_id": "ABCDVMPCV8QTRGGSH8ZW",
    "mandate_status": "PENDING",
    "page_link": "Link"
  },
  "response_key": "success_link_initiation"
}