You can subscribe to APIs by creating an application. Think of an application as your API key and secret management. It’s enables you to retrieve access tokens. You can register as many APPS as you like.
Before you can start using HDFC’s APIs, you must first create an application, allowing you to subscribe to services. Your application allows for the generation of a consumer key, consumer secret, and access/authorization token (if needed) to access the APIs. Follow these steps to create an application:
1. Sign into your account using your registered username and Password.
2. Select the Launchpad menu to navigate to the Apps page to create your first app or view apps that have already been created.
a. Create your first app page
b. View the list of created Apps
3. To create a new app follow the procedure below:
a. APP Name, API Products, IP, Scope and Certificate sections are mandatory for creating any app.
b. App Name: Enter the App name has the limit of 255 characters (Alphanumeric, space, and the following: _ - . # $ %. Must begin with an alpha character) (This input will contain the organisation/ partner name along with the product required as an identifier eg. HDFC_CRMLead)
c. Description: Enter the description has the limit of 225 characters (This input will describe the use case of the partner)
d. Expected Quota: Enter API volumes expected per day.
e. Call-back URL: Optional field (Can be left Blank). A callback URL is a URL that will be invoked by the API method you are calling after it's done.
f. Scope: It is mandatory to mention the scope value as your application would be rejected without it. Kindly enter the organisation / partner name into this field unless specified by Bank Staff otherwise. **While scope field ensures that spaces are not entered, you can separate 2 words with the use of an underscore ‘_’character for the same. e.g. HDFC_Lead.
g. Organization specific Unique value which also allows special characters in it can be passed in scope. Ideally, this value should be a one-word name of your partner organization, without any spaces. Exceptions to this is within the Corporate Payment APIs in the case of fund transfers, IMPS, NEFT & RTGS, where HDFC Bank assigns a specific value to be set as the Scope value.
h. Scope can be a max of 30 characters and one can insert multiple Scope values with comma (,) as a separator.
i. IP: Please enter the public Source IPs that would be used for API Integration in this field. Only IP4 range is allowed. (Multiple IP addresses can be separated with commas). Users can give both Static as well as Public IPs. Multiple IP’s are allowed and must be separated by commas “,”.There is a 600 character IP limit and IP ranges are allowed and should follow the following format : 10.10.10.1-10.10.10.100
j. API Products: Select the API Products (Multiple) that you wish to subscribe to. API Products max field length is about 600 characters. If the sum of the selected API Products exceeds 600 characters, please create another App.
k. Certificate: Upload the leaf SSL certificate in base64 encoded format (.cer/.pem) in the App and share Root and intermediate certificates with Bank separately over email.
l. Accept Terms & Conditions and Privacy Policy of HDFC Bank API Banking Program.
m. Select Add App to add the newly created app in the Apps page.
n. You can add as many apps as you want based on your testing needs.