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 |
---|---|
Confirm |
The Confirm API call allows you to confirm a pending order. Only confirmed orders are settled into the merchant’s account. An order older than 12 days is automatically cancelled. Once an order has been auto-cancelled by the system, it cannot be confirmed. |
Cancel |
The Cancel API call allows you to cancel a pending order. Funds will be refunded to the Credit Card or Debit Card or the Net banking account that was originally charged. An order older than 12 days is automatically cancelled. |
Refund |
The Refund API call allows you to refund an order/transaction that has previously been executed but not yet refunded. Funds will be refunded to the Credit Card or Debit Card or the Net banking account that was originally charged. |
Status |
The Status API call can be used to ascertain the status of a transaction/order. You can use this call if you have not received status/information for a transaction request. It can also be used as an additional security measure to reconfirm the parameters posted back. |
Order Lookup |
The Order Lookup API call can be used to find transactions/orders based on a given criteria. |
Pending Orders |
The Pending Orders API call can be used to list transactions which are yet to be confirmed or cancelled. Pending orders need to be confirmed for them to be settled. Those older than 12 days are automatically cancelled. |
Delete Customer |
The Delete Customer API call is used to delete all saved payment options for the customer. |
Delete Customer Payment Option |
The Delete Customer Payment Option API call is used to delete a particular payment option saved for the customer. |
Add Customer Payment Option |
Add Customer Payment Option API call is used to add another payment option for a registered customer of the merchant. |
Get Customer Payment Option |
The Customer Payment Option API call is used to list payment options saved for a customer. Payment options are saved for a customer in the vault for easy and convenient payments. |
Generate Invoice |
The Invoice API call is used to generate an invoice for a customer. Values can be passed as for generating the invoice using the flexibility of Invoice Settings. |
Generate Recurring Invoice |
Recurring Invoice call is used to generate recurring invoice for a customer of a merchant. |
Generate Quick Invoice |
This Quick Invoice API call is used to generate a quick invoice for a customer. This is a flavour of regular invoice but with limited options; hence an easy implementation. |
Get Item List |
The Item list API call is used to find the list of configured items and tasks for the merchant. The items and tasks are used to create a regular invoice or a recurring invoice. |
Invoice Lookup |
Invoice Lookup API call is used to find a list of invoice orders or look up details of orders. |
Update Merchant Invoice Reference No. |
Update Invoice Reference Number API call is used to update the invoice reference number if the same was not provided at the time of invoice generation. |
Update Merchant Param |
Update Merchant Param API is used to add some extra parameters against merchant parameters if the same could not be done at the time of the transaction. |
Update Billing Details |
Update Billing Details API call is used to update customer billing information against an order. |
Bin Details |
This is used to fetch the card details for a bin number. |
PayId Details |
PayId Details API call is used to list transactions for a given PayId. |
Payouts Summary |
Payouts Summary API call is used to list payouts summary for a merchant for a given settlement date. |
Get Refund Details |
The Get Refund Details API call can be used to fetch refund information of the particular transaction. |
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.