Document

4. Support APIs

3.2. Get Mandate RequestGET

This API is used request a current status of a mandate registration request. The details of the API are given below

4.1.1. Request

Request URL / Method

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

3.2.2. Response

The API returns the standard response described in the Overview section. 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. It should be 7 digit OLD ICS or 18 digit Utility code.
categoryCode	string	Identifies under which category the mandate is created. This has to be one of a fixed set of values provided by NPCI. (see Prerequisites)
schmNm	string	schmNm or consRefNo can be used to identify the mandate source document. E.g. If the mandate is for a house loan, the loan number can be passed as the schmNm or consRefNo. Either schmNm or consRefNo or both must be provided.
consRefNo	string	See schmNm description.
seqTp	string	Allowed Values are: OOFF, RCUR.
frqcy	string	This is an optional field if SeqTp is OOFF. If SeqTp is RCUR, Mandatory field should adhere to the list value available in NPCI List. Allowed Values are: ADHO, INDA, DAIL, WEEK, MNTH, QURT, MIAN, YEAR, BIMN.
frstColltnDt	string	E.g. 2020-01-25
fnlColltnDt	string	Same as frstColltnDt. Mandatory if frqcy is anything but ADHO.
amountTp	string	Allowed values are FIXA or MAXA.
colltnAmt	string	Amount in Rs. e.g. 12000.00 (amount must have paise component).
mandateAction	string	Action of the mandate. Example: Create/amend/etc..
dbtrNm	string	Customer Name.
mobile	string	10 digit mobile number without any country prefix. Example: 9876543210 (no +91).
phone	string	3 char area code + “-” + phone number. Must not have a country prefix. Example: 040-1234567.
email	string	Must be a valid email format.
pan	string	Must be a valid PAN format.
bnkId	string	Customer Bank IFSC/MICR Code.
dbtrAccTp	string	Must be SAVINGS or CURRENT.
dbtrAccNo	string	Customer Account Number.
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.
virtualAddress	string	Alias name with which the payer can be identified by his registered entity. (For NACH Mandate it will appear as Null).
mndtId	string	Unique Mandate Reference Number (UMRN).
mndtType	string	Mandate Type (UPI/OnMags).
debitDay	string	Defines the date/day on which the mandate amount will be debited. (For NACH Mandate it will appear as Null).
debitRule	string	Recurrence Rule (ON/BEFORE/AFTER). (For NACH Mandate it will appear as Null).
requestStatus	string	NPCI status of the Mandate whether Authorized or Rejected.
reasonCode	string	Reason code for the request to be rejected. Only for rejected mandates.
reasonDesc	string	Reason for the request to be rejected. Only for rejected mandates.