4. Support APIs

4.4. Reset Status POST

Once a mandate request is sent to NPCI the status of the mandate request is set to “Progressed by User”. It remains in this status till NPCI ONMAG system responds back. The customer cannot retry the mandate request authorisation while the mandate request is in this status. NPCI provides a Status Check API using which the status of the mandate request can be determined however this API is rate limited to once every 15 mins.

This API is used to reset the status of the mandate request so that the customer can retry mandate request authorisation. The API will return an error if the mandate request for the reference number passed has already been authorised or rejected. It is recommended that a force reset be invoked only after waiting for 15 mins or in if the end customer confirms that the mandate request was not authorised.

The details of the API are given below.

4.2.1. Request

Request URL / Method

Attribute	Value
URL	https:///corporate/mr/{referenceNumber}/reset
Method	POST

Request Body

Name	Mandatory	Max.Length	Type	Description
utilityCode	M	18	AN	Unique Identifier for the merchant. (see Prerequisites)
force	M	3	Yes/No	If “Yes”, mandate request status will be reset to “Initiated”. If “No”, NPCI Status Check API will be called and the mandate request status will be updated based on the NPCI API response

4.4.2. Response

The API returns the standard response. The following tables enumerate the possible “code” values for an API failure and describe the JSON object in the “message” in case of the API success

Response Message Object Details

Name	Type	Description
utilityCode	string	NPCI Identifier for the merchant. (see Prerequisites)
referenceNumber	string	Can be used to refer to the mandate request with the Provider. If not passed, the Gateway will assign a unique reference number.
Status	string	Status of the Mandate.