Sign Up
To review Bank Hapoalim's API Market place and Documentations, you must first sign up.
1. On the top menu, click Sign up.
2. Enter your details and click Next step.
3. Create a password and click Next step.
4. We’ll send you an SMS with an activation code to verify your cell-phone. Enter the code and click Next step.
5. We’ll send you an email to verify your email address. Enter the code and click Done.
Once you are signed up you can log in and get access to our documentations.
Choose an API
Go to the API MarketPlace and select an API.
We provide an overview of the features and documentation to help you decide which API you need. If you plan to use an API in production, view the API requirements, and ensure that you comply.
Register your company
This section is only relevant for Non regulated companies
To use Bank Hapoalim APIs, you need to register your company with us.
1. Log in and click Your companies.
2. Click Register company to start the process.
3. Provide your Company ID number and the company’s legal name in English, then click Register company. You’ll be sent two forms to sign (digitally is also ok).
4. When you’ve completed the forms send them to poalimdevelopersportal@poalim.co.il
Note that the status of your company remains inactive until the company registration is approved. This can take a few days.
5. When your company has been approved, the status of your company changes to Approved.
Add an application
It’s now time to add the application you want to use with the bank’s APIs.
1. Log in and click Your companies.
2. Select Apps on the drop-down menu for the registered company and click Register an app.
3. Provide the app name, a description, and the callback URL to be invoked by the API after it has fetched data.
If you don’t have the callback URL yet, send it to us ASAP at poalimdevelopersportal@poalim.co.il. You won’t be able to create an integration or production environment without it.
4. Click Register app.
Associate the application with API(s)
It’s now time to add the application you want to use with the bank’s APIs.
1. Log in and click Your companies.
2. Select Apps on the drop-down menu for the registered company and click Register an app.
3. Provide the app name, a description, and the callback URL to be invoked by the API after it has fetched data.
If you don’t have the callback URL yet, send it to us ASAP at poalimdevelopersportal@poalim.co.il. You won’t be able to create an integration or production environment without it.
4. Click Register app.
Create an integration and production environment
Once your use of the API has been approved, it’s time to create your integration and production environments. Without these you won’t be able to use the APIs.
1. Log in and click Your companies and then select the Apps tab.
2. In the Certificates area, click Create for the environments you require.
a. When you are ready to develop and test your app with the API, use the integration environment.
b. When you are ready to go live, create the production environment.
3. We’ll send you an SMS with a one-time code. Enter the code and click Verify.
4. The password to download the certificate is displayed in a pop-up. This is the only time it’s displayed, so make sure to copy the password before closing the dialog. If you lose the password, create another certificate.
5. A wizard opens to help you download the certificate. Follow the instructions and download the file to the required destination.
Integrate your application
You are now ready to start developing.
Use the integration environment to access dummy data, and safely try out all API functionality.
For a step-by-step guide on how to use a specific API in the integration environment, go to the related API product documentation in the API Marketplace.
Go live
To go live with your application:
1. Go to the API Marketplace and open the products documentation.
2. In the Requirements section, ensure that you comply with all points.
3. In the Production access section, complete the steps. This process describes how to release your application in a production environment.
Need help?
Do you have a question? On our FAQs page you will find answers to frequently asked questions.
If you did not find the answer to your question, please contact us.
We are happy to help.