API Explorer

GET

GET token

This operation will allow Client to generate token.

Endpoint

{baseURL}/uat/Auth/token

Headers

Authorization: Bearer token
Content-Type: application/json

Request Type

FORM-DATA/ RAW-DATA

Request Fields

No request fields available

Request Body

{}

Response Fields

{
  "status": "Success",
  "message": "This has been posted"
}
POST

Register Mandate API

To submit applicant's mandate data.

Endpoint

{baseURL}/uat/api/NachMandate/registerMandate

Headers

Authorization: Bearer token
Content-Type: application/json

Request Type

RAW-DATA

Request Fields

customer_id

Should be alphanumeric and unique

Validation: Max length 25 characters

loan_no

Loan number, should be alphanumeric

Validation: Max length 25 characters

account_holder_name

Account holder's full name

Validation: Max length 40 characters

account_no

Customer account number

Validation: Max length 35 characters

ifsc_code

IFSC code of the bank branch

Validation: Must be alphanumeric, max length 11 characters

customer_bank

Customer's bank name

Validation: Max length 100 characters

account_type

Type of account

Validation: 1 => Saving, 2 => Current, 3 => CC, 4 => Other

mobile_no

Customer's mobile number

Validation: Exact length 10 digits

email(optional)

Customer email ID

Validation: Max length 40 characters

collection_amt

Collection amount

Validation: Integer, max length 10 digits

max_coll_amt

Maximum collection amount

Validation: Integer, max length 10 digits

collection_frequency

Collection frequency

Validation: 1 => Weekly, 2 => Monthly, 3 => Quarterly, 4 => Semi-Annually, 5 => Annually, 6 => When Presented

debit_type

Type of debit

Validation: 1 => Fixed, 2 => Maximum

mandate_type

Type of mandate

Validation: 1 => Create, 2 => Amend, 3 => Cancel

mandate_date

Mandate date as per NACH mandate

Validation: Format: YYYY-MM-DD

start_date

Start date as per NACH mandate, should be current or greater

Validation: Format: YYYY-MM-DD

end_date

End date should be greater than start_date or blank if until_cancel is true

Validation: Format: YYYY-MM-DD or blank

until_cancel

Indicates if mandate is until cancelled

Validation: 1 => Until cancelled, 0 => end_date should not be empty

sponsor_bank

Sponsor bank code

Validation: 1 => IndusInd Bank, 2 => HDFC Bank, 3 => YES Bank, 4 => ICICI Bank, 5 => Axis Bank, 6 => Ujjivan Bank, 7 => Citi Bank, 8 => IDFC Bank, 9 => Federal Bank, 10 => Bank of Baroda

reference_number

Unique reference number

Validation: Max length 20 characters

return_file(optional)

Indicates whether to return mandate PDF URL

Validation: 1 => Return mandate PDF URL, 0 => Without PDF URL

Request Body

{
  "customer_id": "NPTEST123456",
  "loan_no": "NPTEST123456",
  "account_holder_name": "Nupay Test",
  "account_no": "12345678900",
  "ifsc_code": "CBIN0282923",
  "customer_bank": "Central Bank India",
  "account_type": "1",
  "mobile_no": "8777350601",
  "email_id": "ankur.gupta@nupay.co.in",
  "collection_amt": "125",
  "max_coll_amt": "125",
  "collection_frequency": "6",
  "debit_type": "2",
  "mandate_type": "1",
  "mandate_date": "2024-12-20",
  "start_date": "2024-12-22",
  "end_date": "2024-12-25",
  "until_cancel": "0",
  "sponsor_bank": "1",
  "reference_number": "NPTEST1234567890",
  "return_file": "1",
  "category_id": "13"
}

Response Fields

transaction_id

Generated transaction ID

Validation: Must be alphanumeric

status

Current transaction status

Validation: One of success/failed/pending

redirect_url

Payment page URL

Validation: Must be a valid URL

{
  "StatusCode": "NP000",
  "status": "Success",
  "StatusDesc": "Request accepted successfully.",
  "NupayRefNo": "NP173814474250634",
  "pdf_url": "https://autonach.nupaybiz.com/pdf/NACHPdfUAT.php?reference_number=STlDZEtzNmhmQXR2enRwMkxqOTFXRUhmL21Sa1dROVV0WUpaMVk1bjJqMD0="
}
POST

Get mandate Status API

This operation will allow Client to check the mandate status

Endpoint

{baseURL}/uat/api/NachMandate/nachMandateStatus

Headers

Authorization: Bearer token
Content-Type: application/json

Request Type

FORM-DATA

Request Fields

Request Body

{
  "transaction_id": "TXN789456",
  "status": "success",
  "remarks": "Payment received successfully",
  "update_by": "adminUser123"
}

Response Fields

transaction_id

Transaction ID

Validation: Must be alphanumeric

status

Updated status

Validation: One of success/failed/cancelled

updated_at

Timestamp of update

Validation: Must be in ISO 8601 format

{
  "StatusCode": "NP000",
  "StatusDesc": "Success",
  "status": "Success",
  "Data": {
    "loan_no": "NPTEST123456",
    "customer_id": "NPTEST123456",
    "status_id": "5",
    "status": "Processing",
    "reason_code": null,
    "reason_description": null,
    "umrn": null,
    "creation_date": "2025-01-29 15:57:12"
  }
}