NACH Mandate Form
PURPOSE
This method allows the partner to generate a Mandate form for the customer to automatically debit EMI amount from client’s bank after getting an approval from them. This mandate is handled to National Automated Clearing House, which acts as the mediator between parties and help them clear their balances.
Request Method: POST
Request format: JSON
Request Header
Content-Type: application/json
Ocp-Apim-Subscription-Key: provided by IIFL
REQUEST BODY
HEADER
Field Name | Description | Data Type (max length) |
Mandatory | Sample Value |
---|---|---|---|---|
requestCode | Request Code of the API called | Varchar | Yes | PLRQCL01 |
appVer | Developer App Version | Varchar | Yes | 1.0 |
key | UserKey generated at the time of registration | Varchar | Yes | ABpyyGUh1nsbesSlup3VKURkI4tQDe8y |
osName | Channel of order | Varchar | Yes | WebAPI, Android, iOS |
appName | App Name provided at the time of registration | Varchar | Yes | ALLIANCE |
source | Source provided at the time of registration | Varchar | Yes | 321 |
BODY
Field Name | Description | Data Type (max length) |
Mandatory | Sample Value |
---|---|---|---|---|
ProspectNo | Prospect Number provided while prospect creation | Varchar (10) | Yes | 78946123 |
MandateAmount | Amount to be sent as a mandate | Varchar(10) | Yes | 5000 |
RESPONSE BODY
Head
Field Name | Description | Data Type (max length) |
List of Values | Sample Value |
---|---|---|---|---|
responseCode | This is the response code of API | Varchar(20) | - | PLRQCL01 |
status | This is the response code of API | Varchar(10) | 0 - Success 1 - Fail |
0 |
Source | This is the Partner’s name | Varchar(20) | - | Partner_Name |
statusDescription | Description of the response status | Varchar(50) | - | - |
success_user_status | Status of the user for a partner | Varchar(10) | 0 - Success 1 - Fail |
0 |
BODY
Field Name | Description | Data Type (max length) |
Sample Value |
---|---|---|---|
ProspectNumber | ProspectNumber | Varchar(10) | SL12345678 |
Base64AppForm | Mandate Application form in Base64 string format | Varchar(MAX) |
REQUEST:
{
"head": {
"requestCode": "FTRQNCF01",
"key": "1b7217877d63ebd91adc76615a59e898",
"appVer": "1.0",
"osName": "WebAPI",
"appName": "ALLIANCE",
"source": "xxxxx"
},
"body": {
"ProspectNo": "SL1924505",
"MandateAmount": "5000"
}
}
Response (Success)
{
"Body": {
"Base64AppForm": "Base64string",
"ProspectNumber": "SL1924505",
},
"Head": {
"response_code": "PLRPGNFRS01",
"source": "null",
"status": "0",
"status_description": "",
"success_user_status": "0"
}
Response (Failure)
{
"Body": {
"Base64AppForm": null,
"ProspectNumber": null
},
"Head": {
"response_code": "PLRPGNF01",
"source": "xxxx",
"status": "1",
"status_description": "Invalid token",
"success_user_status": "1"
}
}