v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

Enach - Mandate Management API

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

post/v3/payments/enach/mandate/manage

Headers

client_idstring required

Decentro assigned client_id during on boarding.

client_secretstring required

Decentro assigned client_secret during on boarding.

Request body

reference_idstring required

Unique identifier passed at every request

actionstring required

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

decentro_mandate_idstring required

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

Response

200

decentro_txn_idstring

api_statusstring

messagestring

response_keystring

Example response

{
  "decentro_txn_id": "AFA596C579A64300A036B8093273DE49",
  "api_status": "SUCCESS",
  "message": "Successfully processed mandate cancellation request.",
  "data": {
    "decentro_mandate_id": "10ED96CEBA8C4A93A58810A6E8171096",
    "mandate_status": "CANCELLATION_PENDING",
    "mandate_status_description": "Mandate cancellation request has been initiated"
  },
  "response_key": "success_mandate_action"
}