.



NACH

 

 Services Description of Services

Heartbeat API

This is an API used by NPCI to check the status of the system availability at the bank.

Status Check API - Synchronous

This will be an API used by the system to get the mandate status from the bank immediately after the "mandate registration request time" is completed.

Status Check API- Asynchronous

This will be triggered at specific intervals to get the status of mandate registration at banks.

Cancel API

API to fetch cancel mandate request from the system and provide status to vendor to whom API is exposed to.

Data Fetch API

Application will send an API call for fetching the data such as collection amount & scheme code details for a particular CRN.

File Status API

API call will be used to respond to the NACH core application about different business operations such as file uploaded successfully, file rejected for the respective CRN.

Current Day API

A corporate user can view current day's collection in the collection overview screen and data will be fetched from the system on a real-time basis using the rest-based API.

Historic Data API

Application will pick up data of collection summary of 1 week, 1 month, 6 months & 1 year from data warehouse table from the system into the application.

Approve Mandate API

Action of Approve Mandate will be done by a checker corporate user and communicated to NACH Core Application using rest based API.

Reject Mandate API

Action of Reject Mandate will be done by a checker corporate user and communicated to NACH Core Application using rest based API.

Approve Transaction API

Action of Approve Transaction (Single/Bulk) will be done by a checker corporate user and communicated to NACH Core Application using rest based API.

Reject Transaction API

Action of Reject Transaction (Single/Bulk) will be done by a checker corporate user and communicated to NACH Core Application using rest based API.

Mandate Status

To fetch status of Mandates from MPS.

Activate/Deactivate Servers API (Manage Environment)

Option provided in MPS to activate/deactivate servers connected with NPCI for file-based upload. This menu allows maintaining banks connectivity between the bank and NPCI for file processing.

Destination Bank API (Approve Posting)

MPS processes the file received from NPCI and creates a transaction file, sends the transaction information to CBS, receives and processes the response file.

ReCreate Posting

The ReCreate Posting option recreates the posting and sends the returned transaction to the core banking system for processing.

Bulk Mandate for Mandate Creation

API to fetch Mandate information from Corporates or Bank backend system to generate a single file for sponsor bank to upload Mandates with NPCI having all the required mandate information.

Transaction Posting- Single/Bulk

The bank may upload bulk mandates into the NACH system or enter details of single mandates, as required. For bulk upload, the bank will need to store all the mandate images in a folder and place it in the relevant directory.

Quickcheck API

QuickCheck API is platform independent and can be used in any corporate application including but not limited to mobile applications. This enables corporates to use their interface or application with the benefits of QuickCheck platform (Account Validation, Mandate Registration)

You can explore these APIs through our Sandbox

Try Now

 

Frequently Asked Questions

icon

How do I register on the developer platform?

Registration is simple!

  • Click on Register and complete the Personal Information form.
  • Accept the Term and Conditions and then click Next Step.
  • Fill out the Additional Information form and then click “Register Now” button.
  • Your request will be shortly approved by the admin


Note
: The Kotak Developer Connect Portal does not permit registration of duplicate organization names. As a result, after the first developer from an organization has registered an account with the portal, subsequent developers from that same organization require an invitation to be registered.


Registering as a new Developer (also becomes the organisation admin).

What are the personal & additional details required for registration on the Developer Platform?

Tab

Description

Personal Information

Complete the personal information fields, with all the required fields.

Please keep the following points in mind:

  • Ensure that the email address is entered correctly, as a notification will be sent to that address for the Developer to activate the approved account.
  • The username must be unique.
  • The disclaimer check box must be selected.
  • All fields with an asterisk (*) must be completed in order to access the other tabs. Alternately, you may proceed to step 2, below.

Additional Info

This tab records information about the Developer’s organization as well as any custom information requested by the Portal for registration.

 

  • Organization Name: Optionally enter the name of the Developer’s organization. This will appear as the Organization Name on the Kotak Developer Connect Portal. If left blank, the username with “_org” will be used as the Organization Name.
  • Organization Description: Optionally enter a description about the organization. This will appear as the Organization Description on the Kotak Developer Connect Portal. If left blank, the username will be used in the Organization Description.



What is the procedure to add a new developer under an organisation?

To invite a new member to your organisation, see “Manage your Developer Organisation”

  • The Kotak Developer Connect portal provides two main roles to users within an organisation depending on the registration. To know more, see “Manage your Organisation”.
  • On the Kotak Developer Connect Portal home page, click Register in the upper right corner. Complete the registration dialog box as follows.
  • Click Register Now. You will receive an email stating that the account is under review. Upon completion, you will be emailed a link to click on in order to activate the account.

    Tip: If the email does not appear in your inbox, check your junk mail folder.

How do I create an application?

Add New Application and obtain API key to get started

Developers can add applications of their own through the Kotak Developer Connect Portal. Once you get access to the Kotak Developer Connect portal, you can start using our APIs. By default, you are assigned an account default plan. To know more about the plans, click here.

Once you login to your account, you get access to a dashboard which allows you to create an application and provide usage analytics options.

In order to consume an API, you need to “Add an Application” by clicking in the Applications tab and then “Add Application”. Here, you can add all the required APIs in your application and request access. The admin shall shortly approve your access depending on the APIs you have chosen.

To add a new application:

  • Go to the Dashboard. You can access it by clicking the Dashboard near your profile picture.
  • In the left navigation pane, click Applications. The list of your applications will appear.
  • On the Manage Applications screen, scroll below and click ‘Add Application’ to add an application.
  • Enter your application name and then choose an appropriate platform for the application from the drop-down menu.
  • Provide a brief description of your application and click ‘Next Step’ to proceed to the ‘API Management’ tab. Refer to the table below.
  • You are now ready to add APIs to your application as per usage. Select the API you want to add to your application from the dropdown menu under the Add API header and accept the Terms and Conditions.
  • In case your application requires the usage of multiple APIs, you can easily add multiple APIs to the same application by repeatedly following the above steps and by selecting the required APIs from the dropdown menu under the Add APIs header.
  • Once satisfied, click ‘Next Step’ to proceed to ‘Auth’ tab where you can optionally provide ‘Callback URL’, ‘Scope’ and ‘ Type’ for the authentication procedures. Refer to the table below.
  • Click Save when done.

Note: The system will send you an email confirming the API application. Your application shall be reviewed and approved by an API manager admin. It might take up to a day to get your application approved. The application appears on the Applications page, showing a status of Pending Approval.

Tab

Description

Application Information

  • Name of Application: Enter a name for the application.
  • Platform: Choose a platform from the menu provided.
  • Description: Enter a description of the application, such as details about the platform, whether it is a mobile application, etc.

Note: The Name of Application and Platform fields must be completed in order to proceed to the next tab.

API Management

Choose an API or API group from the menu.  (take tip to the next line)
Tip: You can expand an API group to see the name, usage, and API plan of each member API.

Read the End User License Agreement (EULA) and then click I Accept the Terms and Conditions. If needed, add additional APIs or API groups.

Auth

If your application is using OAuth 1.0 or 2.0, complete the following fields as appropriate:

  • Call back URL: Supply a call back URL in this field. You can enter multiple URLs separated by commas.
  • Scope: Enter the scope or list of access permissions for this client. Scope can be designated in many ways: as a list of resources; URLs or URIs of service endpoints; etc. Scope is a required field for OAuth clients. By default, the Scope is set to OOB (Out of Band).
  • Type: Select a client type from the menu. Choose Public for client-side OAuth clients (such as browser-based JavaScript clients) or Confidential for server-side clients. Confidential is also the required type for the OAuth 2.0 Grant Type of Implicit.

How do I track my previous application for an API on the Developer Portal/Platform?

  • You can view the approval status of your application in the Application table on the same page. You can also review the details of the application by clicking the gear icon next to the application name.
  • After the application has been approved or rejected, the Organisation Administrator will receive an email notification of its status. An approved application will have a status of Active and will be assigned an API Key. If an application is rejected, it will be returned with a status of Rejected with details of the rejection sent via email. You can then edit the application. After you save your edits, the application will be added to the Business Manager's queue with a status of Revised. Rejected applications can only be revised once. See "Edit Applications " for details.

Please login to the API manager and navigate to the Application tab from the left navigation pane. Click on the gear icon next to your application for configuration, select Edit and go to the Auth tab to retrieve Key and Secret. You can also see your API key from the Applications table under the API key column.

I have created an application but it is still not approved. Whom do I contact?

Please reach out to your respective Relationship/Business Manager.

How do I test the API?

Test APIs using Test Suite!

Test suite helps you to explore the APIs in an interactive fashion. In order to explore the APIs, login into the portal and then follow the step-wise instructions below:

  • After successful login, navigate to the Test Suite tab.
  • Select the API you want to test. Select the Resource and Method from the drop-down menus, respectively.
  • Select the type of authentication method by clicking “Authentication (None)” in the API key block towards the right.
  • Scroll down to the Request tab and provide the XML or JSON query for the API request in the empty text box present.
    • You can access the API documentation from the Documentation tab. The APIs are structured under various categories, click on the required category, say General, to view the APIs under that category. All the APIs have a text documentation as well as an interactive documentation.
    • Click on the API specific doc, say Pan Verification Doc, to read the various properties of the API. Scroll below to see a sample example query XML or JSON code.
    • Copy and paste this sample query code in the Test Suite tab, as required.
    • You can also define parameters via the Add Parameter dialog box that can be used to add additional parameters that are not otherwise specified in the WADL file.
  • Click ‘Execute Request’ button to execute the API request. Depending on the query string you shall receive the response.
  • Navigate to the ‘Query’ tab which shows the query string sent. By clicking on the drop-down menu, you can get a code snippet, with the supplied query, ready to be integrated in your code.

You can explore various APIs in a similar fashion.

How do I edit/modify or delete the application created?

Steps to Edit/Delete Applications 

Developers and Organisation Administrators can edit their applications via the Manage Applications page. They can also add, edit, enable, disable, or delete them, as outlined in "Adding New Applications" and “Managing Applications".

If a new application has been rejected, its status will appear as Rejected in the list of applications and the details of its rejection will appear in an email. When you edit the application and save your changes, the application will be resubmitted and will display a status of Revised.

To edit an application:

  • On the Dashboard, select Applications on the navigation sidebar. The list of your applications appears on the Manage Applications page.
  • On the gear menu beside the application, choose Edit.
  • Perform a task from the following table:
Tasks for editing applications
 

If you want to …

Do this...

Change the name or description of an application

  • On the Application Information tab, modify the Name of Application or Description

Add or delete APIs associated with an application

  • On the API Management tab:
    • To remove an API or API group, click the X beside the API or API group.
      Note: You cannot remove an API from an API group.
    • To add an API or API group, choose an API from the menu. Read and accept the EULA. Click Save. You will receive an email confirmation.

Tip: You can expand an API group to see the name, usage, and API plan of each member API.

Change API Plan for an API

  • On the API Management tab, if the API is in an API group, open the group.
  • Beside the API, choose a new plan from the Request Change to menu.
    You will receive emails confirming the change request and later notifying you whether the request has been accepted or rejected.

Change the Key
Secret for an API

  • On the Auth tab, click Secret to access the Key Secret field.
  • Click Request a New Shared Secret and click OK to confirm.

Change a callback
URL

  • On the Auth tab, edit the callback URL.
  • On the Dashboard, select Applications on the navigation sidebar. The list of your applications appears on the Manage Applications page.
  • On the gear menu beside the application, choose Edit.
  • Perform a task from the table given above
  • Click Save when done. 

What is the difference between an account plan and an API plan?

Here’s what you need to know

 

Account Plan: - This refers to a plan which is subscribed by an organisation while doing the organisation registration which will differ basis the no. of hits & TPS allowed for partner/organisation.

API Plan: - This refers to the APIs which will be subscribed by partners for specific products.