Document

4. Support APIs

4.2. Search API GET

This API is an enhanced version of Get Mandate API, where instead of passing reference number, you can search for mandates by passing a single parameter or a combination of multiple parameters in the API Request body.

Some of the parameters are consumer reference number, customer mobile number, customer email id, status, created by, created from and too dates, etc

Invoking this API will generate single or multiple outputs based on the search results returned.

4.2.1. Request

Request URL / Method

Attribute	Value
URL	https:///corporate/mr/search
Method	GET

Request Body

Credit Details object +

Name	Mandatory	Max Length	Type	Description
fromCreDtTm	O	10	Date	Date range of mandate creation. Format: YYYY-MM-DD
toCreDtTm	O	10	Date	Date range of mandate creation. Format: YYYY-MM-DD
consRefNo	O	35	AN	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 consRefNo.
createdBy	O	35	AN	User who had created the mandate.
email	O	50	AN	Must be a valid email format. Note: Either one of the fields to be mentioned, Email or Mobile number.
status	O	50	AN	NPCI status of the Mandate − Initiated, Progressed by User, Transaction Open Status, Authorized, Rejected By NPCI, Authorization Request Rejected, Cancelled, Expired.
source	O	20	AN	Mode of mandate creation − USER_INTERFACE, API, BULK_UPLOAD, MOBILE, WEB.

Mandate Details object +

Name	Mandatory	Max Length	Type	Description
mndtType	O	10	AN	This must be one of the values below: • UPI • OnMAG Note: If the attribute is not mentioned in the Create Request, the default will be considered as OnMAG. (For UPI Mandate Only)
authMode	O	50	AN	Mode of user authorization − DebitCard, Aadhaar, NetBanking.
mandateAction	O	20	AN	Mandate Action being performed − Create, Cancel, Amend, Suspend, Revoke.
organizationUnit	O	50	AN	Corporate Internal Branch identification, if any.
amount	O	13	#.00	Amount to be collected from the debtor's account. Amount in Rupees with paisa component. Example: 12000.00

Account Details object +

Name	Mandatory	Max Length	Type	Description
consumerName	O	40	AN	Customer Name
accNum	O	35	AN	The account of the debtor, to which a debit entry will be made as a result of the transaction.
mobile	O	10	Numeric	10 digit mobile number without any country prefix. Example: 9876543210 (no +91)
umrn	O	18	AN	Unique Mandate Reference Number (UMRN)
bnkId	O	4	AN	Customer Bank short code

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
id	serial4	Stores mandate records uniquely in serial wise numbering.
corporateCode	string	Unique short name given to corporate during time of onboarding. It is used to identify the corporate.
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.
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	Allowed Values are: OOFF, RCUR. This is an optional field SeqTp is OOFF. If SeqTp is RCUR, mandatory field present should adhere to the list value available in NPCI. Allowed Values are: ADHO, INDA, DAIL, WEEK, MNTH, QURT, MIAN, YEAR, BIMN.
frstColltnDt	string	Starting date of collection. Format YYYY-MM-DD. Example: 2024-01-25.
fnlColltnDt	string	End date of collection. Format YYYY-MM-DD. Example: 2064-01-25 (Allows up to 40 years from frstColltnDt as per NPCI guidelines).
amountTp	string	Allowed values are FIXA or MAXA.
colltnAmt	string	Amount in Rs. e.g. 12000.00 (amount must have paise component).
dbtrNm	string	Customer/Debtor Name.
phone	string	3 char area code + "-" + phone number. Must not have a country prefix. Example: 040-1234567.
mobile	string	10 digit mobile number without any country prefix. Example: 9876543210 (no +91).
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.
creationDate	date	Date on which mandate was created.
creationTimestamp	timestamp	Timestamp on which Mandate was created. Example: 2023-08-17T10:16:17.324005.
createdBy	string	Displays the user who had created the mandate.
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.
requestStatus	string	NPCI status of the Mandate, whether Authorized or Rejected.
authMode	string	Displays mode of user authorization − DebitCard, Aadhaar, NetBanking.
source	string	Displays mode of mandate creation − USER_INTERFACE, API, BULK_UPLOAD, MOBILE, WEB.
sourceReference	string	Similar to referenceNumber, separated by '−'.
shortUrl	string	Authorization link which is sent to customer on mandate initiation.
npciRefMsgId	string	Reference ID generated by NPCI.
mndtId	string	Unique Mandate Reference Number (UMRN).
rejectBy	string	Mandate rejected by − NPCI, Bank, UIDAI, MMS.
errorCode	string	Error Code.
errorDesc	string	Error Description.
accptd	string	NPCI responds on mandate success or failure with either 'true' or 'false'.
accptRefNo	string	Given by NPCI at the time of authorization.
reasonCode	string	Reason code for the request to be rejected. Only for rejected mandates.
reasonDesc	string	Reason description for the request to be rejected. Only for rejected mandates.
lastProgessedTime	timestamp	Last time user made any progress on the mandate.
authorizedDate	date	Date when the mandate was authorized.
authorizedTimestamp	timestamp	Displays timestamp when mandate was authorized.
expiredDate	date	Date when mandate has expired.
mndtType	string	Mandate type − ONMAG, UPI.
customerBankCode	string	Customer Bank Account IFSC Code.
siAccNo	string	Nil.
siMmbId	string	Nil.
mandateAction	string	Mandate Action being performed − Create, Cancel, Amend, Suspend, Revoke.
organizationUnit	string	Corporate Internal Branch identification if any.
surl	string	Null.
failedattempts	int4	Number of failed attempts to authorize the mandate.
actualColltnAmt	string	Displays the last updated amount for MAXA (Maximum Amount/Variable Amount) Mandates that will be considered for collection.
debitDay	string	Represents the Collection day.
autoExecute	string	Default value is 'N'.
addnlRefNb1	string	Additional field 1.
addnlRefNb2	string	Additional field 2.
addnlRefNb3	string	Additional field 3.
orgnlRefNb	string	Nil.
actionReasonCode	string	Displays the code based on the action.
nachUtilityCode	string	Refer to the Utility Code.
upiUtilityCode	string	Utility Code registered for UPI.
biStatus	string	Status of the Mandate maintained at Sponsor Bank, if any.
consentReqId	string	Unique reference number generated at the time of raising consent.
consentReqStatus	string	Status of consent − ACTIVE, INITIATED, REJECTED, FAILED, FAILED: Invalid date range.
virtualAddress	string	Alias name with which the payer can be identified by the registered entity. (For NACH Mandate, this will appear as Null).
accountValidation	string	Displays as Y/N.
revokeable	string	Displays as Y/N.
imageData	string	Image data.
imageName	string	Image name.