Unlock the power of Open Banking
Kotak's state-of-the-art API solutions can seamlessly
integrate and meet all your solution needs.
Create a better experience with Kotak APIs.
.
Services | Description of Services |
---|---|
Create Virtual Account |
The client application can create single or multiple virtual accounts under a single physical account number, by calling this API with required input. If the call is successful and the new Virtual Account Number is accepted, the API will return a success message. The API will return a failure message with reason, in case of any error. |
Modify Virtual Account |
The client application can modify/update single or multiple virtual accounts under a single physical account number, by calling this API with required input. |
Delete Virtual Account |
The client application can delete single or multiple virtual accounts under a single physical account number, by calling this API with required input. |
Transaction Details |
If a customer sends a request to the bank along with the given request parameters, the bank will share the batch of 100 records on every request. In response, the bank will expect an acknowledgement of receipt of the 100 records. This response will be standard. |
Refund Details |
This API will be called by the customer and refund will be initiated by the bank. The customer sends a request along with the client name and the transaction reference number for which the refund needs to be initiated as per the shared request format. The bank will validate and initiate the refund via payment service. In response, the bank will share the initial response received. |
Registration is simple!
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).
Tab |
Description |
Personal Information |
Complete the personal information fields, with all the required fields. Please keep the following points in mind:
|
Additional Info |
This tab records information about the Developer’s organization as well as any custom information requested by the Portal for registration.
|
To invite a new member to your organisation, see “Manage your Developer Organisation”
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:
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 |
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) 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:
|
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.
Please reach out to your respective Relationship/Business Manager.
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:
You can explore various APIs in a similar fashion.
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:
If you want to … |
Do this... |
Change the name or description of an application |
|
Add or delete APIs associated with an application |
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 |
|
Change the Key |
|
Change a callback |
|
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.