We are currently publishing this for new developers or existing partners with a new initiative. If you do not have an integration with ICICI Bank, use these APIs to get started.

You can sign up for a new Developer account and create an API key on your Developer Console. For more information, see our Documentation page. If you are an Enterprise Developer interested in adding or updating an application, please contact your Account Manager before creating an API key. If you are not able to access your Developer Console, contact your Account Manager.

API is the abbreviation for “Application Programming Interface”. An API allows a third party application to use a common set of services via a defined interface.

Simply create an account on the developer portal and then create one or more applications. Each application will get its own API key. Once your application is ready to go live you can request for an account plan upgrade via your Developer Console.

OAuth is an authentication protocol. For more information, please visit oauth.net.

REST (Representational State Transfer) is a simple stateless architecture i.e. each operation is entirely defined by the information sent to and received from the service. When a web service uses this architecture, it is known as a REST API.

The Organisation Administrator is your company’s representative for the ICICI Bank Developer Portal. This person has overall responsibility for the ICICI Bank Developer Portal account, and has access to all the services and functions available on the site. The Organisation Administrator’s main responsibilities include:

• Adding, deleting and managing your organisation’s developers
• Adding, deleting and managing your organisation’s applications
• Editing organisational details
• Requesting API keys and authentication
• Changing API Plans or Account Plans
• Checking API usage and analytics.

The Organisation Administrator is ICICI's first point of contact regarding the ICICI Bank Developer Portal.

Only users with the enterprise administrator role can add users. You can manage your users and permissions at User Managament page.

You will see details of various error responses within the API specifications. The Error description field in a response is meant to detail a message for the user. Refer to the error code information which details what the error code means and how this error code should be handled.

An Account Plan is a collection of one or more APIs. Every developer organization has an Account Plan. When a developer registers for a new organization account, the organization is automatically assigned to ‘Bronze Account Plan’. Using ‘Bronze Account Plan’ you can only consume ‘Test’ APIs. In order to consume ‘Production’ APIs, you have to upgrade your account plan to ‘Production Account Plan’.

An API Plan is a predefined set of rules and quotes of how to consume an API. Currently, we provide ‘Sandbox’ and ‘Production’ API plans. ’Test’ APIs are only available via ‘Sandbox API Plan’ and they are restricted to some quotes which means you will have limited access. On the other hand ‘Production’ APIs available via ‘Production API Plan’ can be consumed with higher quotes and they process live data. As mentioned under the title ‘What is an API Plan?’ you have to upgrade your account plan to ‘Production Account Plan’ in order to consume ‘Production’ APIs.

Yes, sandbox APIs are currently restricted to a limited number of calls, according to API Plan’s context.

Developers have to be invited by their Organisation Administrator to join the portal. Once joined, they can access most of the same functions as the Organisation Administrator. There are a few things developers won’t be able to do, and this includes inviting other developers to join, changing API or Account plans, or editing organisational details.

Your organisation has a choice of two Account Plans:

• Our Standard Plan is a free service that gives you up to 10,000 hits per day over your applications and standard technical support through our portal.
• Our Premium Plan is a chargeable service that gives you a higher number of hits per day or hour - with enhanced, personalised technical support as well as the standard support available through our portal.

If you’re an Organisation Administrator, you can change your Account Plan by going to Dashboard/Applications. Simply select your preferred plan under ‘Account Plan Change’ in the first table. We’ll automatically be notified of your request and be in touch with any further requirements we may need from you.

If you’re an Organisation Administrator, you can request to move from Sandbox to Production for each API within a specific application using this portal:

• Go to Dashboard/Applications.
• Click on the cog icon next to your application and select ‘Edit’.
• Click on the ‘API Management’ tab.
• Under ‘API Plan Change’ select ‘Production’.

We’ll then be in touch with any further requirements we may need from you.

No, so please make sure you’re certain you don’t want the application before deleting it.

Yes. Go to Dashboard/Applications, click on the cog to the right of the application, then ‘Disable’.

No. But your Application may be suspended or deleted which will suspend or delete the associated API key.