Get started - Open Banking APIs
Welcome to develop.hsbc
This short guide will get you started with our Open Banking APIs and enable you to begin integrating our services into your applications.
On this page
Interface overview
We currently provide both Public (Open Data) and Private APIs and Modified Customer Interfaces (MCIs) across Hong Kong SAR, UK, EU, Bahrain and Mexico. Here’s an overview of the interfaces we’ve implemented in each of the markets in which we have Regulatory Open Banking commitments.
| Country | Channel / Brand / Service | API | MCI |
|---|---|---|---|
| Bahrain | HSBC Personal Internet Banking | Yes | No |
| Belgium | HSBCnet | Yes | Yes |
| Channel Islands/ Isle of Man (CIIoM) | Expat & Domestic | Yes2 | No |
| Czech Republic | HSBCnet | Yes | Yes |
| France | HSBCnet | Yes | yes |
| ElysPC - Business Internet Banking | No | ||
| Ma Banque en ligne - Personal Internet Banking | |||
| MiVision | |||
| Germany | HSBCnet | Yes | Yes |
| HSBC Private Banking Online Banking | Yes3 | No | |
| Greece | HSBCnet | Yes | Yes |
| HSBC Personal Internet Banking | No | ||
| Hong Kong SAR | HSBC Business Internet Banking | Yes4 | No |
| Ireland | HSBCnet | Yes | Yes |
| Italy | HSBCnet | Yes | Yes |
| Luxembourg | HSBCnet | Yes | Yes |
| Malta | HSBCnet | Yes | Yes |
| HSBC Personal Internet Banking | No | ||
| Mexico | Open Data | Yes | No |
| Netherlands | HSBCnet | Yes | Yes |
| Poland | HSBCnet | Yes | Yes |
| Spain | HSBCnet | Yes | Yes |
| UK | HSBC Personal Internet Banking | Yes1 | Yes |
| first direct Online Banking | |||
| M&S Bank Internet Banking | |||
| HSBC Business Internet Banking | |||
| HSBC Kinetic | |||
| HSBCnet | |||
| HSBC Private Banking Online | No | ||
| John Lewis Finance | |||
| MiVision | |||
| Open Data | Yes | No |
1 - Our TPP Implementation Guide provides details of which products are covered for each brand by our UK APIs.
2 - Our APIs for CIIoM will cover credit cards issued under UK license only. Products issued under local license will not be covered.
3 - Follow this link or details of our HSBC Germany Private Banking APIs.
4 - Account information APIs only.
What does develop.hsbc provide?
develop.hsbc provides technical documentation and testing facilities related to the Open Banking interfaces we’ve implemented. To help you get to the resources you need, here’s a summary of what the portal currently provides in each market.
| Market / Region | Public API | Private API | MCI | ||
|---|---|---|---|---|---|
|
UK and CIIOM |
Interface implemented |
P |
P |
P |
|
| Resources provided |
Technical Documentation |
P |
P |
P |
|
|
- 'Try it out' function |
P | P | n/a | ||
|
Testing Facilities |
O |
P |
P |
||
|
EU |
Interface implemented |
O |
P |
P |
|
| Resources provided |
Technical Documentation |
O |
P |
P |
|
|
- 'Try it out' function |
O | P | P | ||
|
Testing Facilities |
O |
P |
P |
||
| Bahrain | Interface implemented |
O |
P |
O |
|
| Resources provided |
Technical Documentation |
O |
P |
P |
|
|
- 'Try it out' function |
O | P | O | ||
| Testing Facilities |
O |
P |
O |
||
| Mexico | Interface implemented |
P |
O |
O |
|
| Resources provided |
Technical Documentation |
P |
O |
O |
|
|
- 'Try it out' function |
P |
O | O | ||
|
TPP Onboarding / Client Registration |
P (SSA provided for |
O |
O |
||
| Testing Facilities |
O |
O |
O |
||
| Hong Kong SAR | Interface implemented |
O |
P |
O |
|
| Resources provided |
Technical Documentation |
O |
P |
O |
|
|
- 'Try it out' function |
O | P | O | ||
| Testing Facilities |
O |
P |
O |
||
Registration on develop.hsbc
To access resources for our Private APIs and MCIs in the UK, Europe and Bahrain and Hong Kong and Public API in Mexico, you’ll need to register on develop.hsbc first.
- Please go to the Registration page to set up your account.
- Activate your account using the link sent via confirmation email.
- You’ll now be able to access the relevant technical documentation and generate test certificates in order to access our testing facilities.
If you register for access to our Mexico Public API you’ll be able to generate a Software Statement, which you’ll need as part of the Dynamic Client Registration process for the production API.
You don’t need to register to access the UK Public API documentation. Please use it to establish connectivity to HSBC and access the services provided.
Only Hong Kong Phase III API’s are available on this site. For Phase I and II API’s please visit developer.hsbc.com.hk
Technical documentation
All our technical documentation as well as guidance on how to use our testing facilities – for both APIs and MCIs - can be accessed from the API Catalogue. Use the filters to identify the cards (or tiles) which correspond to the resources you are interested in.
Our technical documentation includes an overview of which brands or markets are supported by each interface and our detailed implementation guides provide details of how to integrate our API / MCIs into your app. Each end point has the ‘Try it out’ function and you can also download the spec.
Testing facilities
When you’re ready to test, we’ve implemented testing facilities for our Open Banking APIs in the UK, Europe and Bahrain and Hong Kong and for some of our MCIs.
Open Banking API Sandbox
We’ve now launched our new OB API Sandbox, which supports our UK, Bahrain and Channel Islands/ Isle of Man (CIIoM) APIs.
You can find full instructions on how to access and use the sandbox with our technical documentation
Our API sandboxes only accept test certificates generated by HSBC and are loaded with dummy customer data, which reflects what will be returned in production API responses.
We don’t provide sandboxes for our Open Data APIs in the UK or Mexico.
MCI Test Facility
We’ve implemented MCI Test Facilities for our Personal and Business Banking brands in France, our Personal Banking brand in Greece and our Business Banking brand – Kinetic - in the UK.
Our MCI Test Facilities accept either your own OBWAC or QWAC or a test certificate generated by HSBC. A step by step guide to generating test certificates is included in the MCI Test Facility documentation.
Once you’ve got your certificate, call the test facility URL for the channel you want to test against and once your certificate has been validated, you’ll be routed to the login page of the test facility instance of the channel you want to test against. You’ll find the required test user credentials in the MCI Test Facility documentation. The MCI Test Facility for each channel replicates the corresponding direct channel to enable you to progress the development and testing of your application before launching it.
Feedback and Support
Dive in and start coding your applications. If you get stuck or require additional support, then please contact our team using the Support form found under Help menu.