API Reference

Initiate ENach registration

Initiate ENach registration using appropriate inputs.

Endpoint:

POST /api/v1/nach/enach/initiate/

Sample payload is given below:

{
   "amount": "<maximum amount>",
   "account_number": "<customer account number>",
   "email": "<email id of the customer>",
   "name": "<name of the customer>",
   "mobile": "<mobile number of the customer>",
   "bank": "<bank code>",
   "account_type": "<current/savings>",
   "auth_type": "<card/netbanking>",
   "debit_type": "<variable/fixed>",
   "start_date": "<debit start date>",
   "end_date": "<debit end date>",
   "frequency": "<frequency of debits: daily/ weekly/ monthly/quarterly/ semiannually/ yearly / bimonthly /adhoc>",
   "response_url": "<response url>",
   "loan_account_no": "<Loan Account Number to associate with the given loan.>"
}

This API returns a unique identifier for identifying ENach:

{
    "is_success": true,
    "data": {
        "enach_id": "enach uuid"
    }
}

This identifier will be used for all other APIs, so it must be stored in your database. Use this transaction id to initiate the enach registration process using the javascript SDK. The javascript SDK can be found here. Once loaded call the function like below with the enach UUID passed into it.

NOTE:

You will not be able to set up an e-Mandate if you have a joint account mapped or current account with multiple signatories. This restriction is in place from the respective banks' end.

For such cases, you should do Physical nach.

Banks are usually providing enach to savings account and current account holders with sole proprietorship.

If the current account holder is corporate or maker checker then banks are not providing enach facility.

This is respective bank's decision.

Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!