Frequently Asked Questions
User can generate N number of API Keys as per their requirements.
An API key or application programming interface key is a code that gets passed in by computer applications. The program or application then calls the API or application programming interface to identify its user, developer or calling program to a website.
Application programming keys are normally used to assist in tracking and controlling how the interface is being utilized. Often, it does this to prevent abuse or malicious use of the API in question.
An API key can act as a secret authentication token as well as a unique identifier. Typically, the key will come with a set of access rights for the API that it is associated with.
Scope associated with the developer application on the dev portal indicates the partner app invoking the API and we generally recommend partners to use their company name or a specific value provided by HDFC.
Client ID and Client Secret are unique credentials for each customer application that are required to access any subscribed APIs. As part of the onboarding process on the API Portal, Partners need to create an application. On approval of the application, the Client ID and Client Secret will get generated automatically on the API Portal. The Client ID needs to be utilized as the value of the API key to be sent in the API request header.
In cases where the API indicates that OAuth is needed, the Client ID is additionally used as ‘Username’ while Client Secret is used as the value of 'Password' in the Authorization Headers for the OAuth API call (More details on OAuth API is available in the Technical User Manual).
Client ID and Client Secret can be accessed on the API Portal, within the Partner’s application, in the AUTH tab. These values are unique for each application created by you on HDFC Bank’s API Portal.
Client ID and Client Secret values are generated automatically and partners cannot change them.
API is a reusable component which developer uses to complete its system. API Product is a bundle of such APIs. APIs in one product are logical in the sense it tries to complete the needs of partner in one product only.
Once you have registered, you can log into the HDFC Developer Portal to access the technical documentation on our API Products. Go to the API catalog section of the portal for further details.
Once you create an account on the HDFC Bank Developer portal, you can access the Sandbox. There you can make API calls that mimic our production environments. In the Sandbox, we use mock data so that you can prototype your application as if it were the real thing.
Our API Catalog page can show you what APIs are available segregated the product basis. If you have a really strong business case for a new API, we’d love to hear about it.
Think of an application as your API key and secret management. It’s enables you to retrieve access tokens. You can register as many as you like.
Error 4xx
This series mainly addresses errors occurring on the client side.
• Bad request- 400
• Unauthorized- 401
• Forbidden- 403
• Not found -404
• Conflict-409
• Unsupported media type-415
Error 5xx
A. This series mainly addresses errors occurring on server side.
B. Internal Server Error-500
C. Not implemented-501
D. Bad Gateway-502
E. Service unavailable-503
F. Gateway timeout-504
The HDFC Developer Portal is a platform for subscribing APIs, testing your product journeys in our sandbox and launch your products by partnering with HDFC Bank. Corporates, Fin-techs, Start-ups, E-Commerce Players, BFSI companies and developers interested in using these APIs can register for the portal and test the APIs in a secure sandbox environment.
API stands for Application Program Interface or Application Programming Interface. It is a set of commands, functions and procedures programmers can use when building applications. HDFC Bank's APIs allows programmers to use pre-defined functions to interact with the Bank's applications. One application can use an API to make a standardized request to another application and get the other application to take the input, perform an operation and return standardized output back to the original application.
To register, visit the registration page.
Go to the login page and click on ‘Forgot password?’. Make sure to enter correct username or email address. You will receive an email to reset your password.
HDFC Bank welcomes innovation and constantly continues to change the way we do business. With Embedded Finance and Open Banking taking central stage in current Banking Environment, it is imperative that we open up our API stack for the new age businesses take advantage of our offerings. Help us do things better. Help us help you.
You can test our APIs and your user flow in our sandbox environment before implementing
Request you to reach out to your dedicated RM for sharing details on your journeys and APIs that needs to be consumed. He shall update you on commercials, if any. Or you can reach out to us via contact us option to address your queries