Registration on develop.hsbc

To access resources, including technical documentation and the sandbox you’ll need to register on develop.hsbc first. 

1. Please go to the Registration page to set up your account for Open Banking
2. Activate your account using the link sent via confirmation email
3. You’ll now be able to access the relevant technical documentation and generate test certificates in order to access our testing facilities (Sandbox) via the Dev Hub (top right)

If you registered 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. This is available from your profile (top right) under Mexico Dashboard.

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 endpoint has the ‘Try it out’ function and you can also download the spec under the secondary navigation option "Endpoints" by selecting "Source File".

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

Our Open Banking Sandbox supports our UK, Bahrain and HK APIs.

You can find full instructions on how to access and use the sandbox with our technical documentation by following the "Sandbox Access Guide" on the right hand menu.

Our API sandboxes only accept test certificates generated by HSBC (select Dev Hub then create project to create your credentials you will need to access the sandbox). Our Sandbox is loaded with dummy customer data, which reflects what will be returned in production API responses. Test Customer Profiles have been created to assist you in completing your testing for various use cases.

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 various brands.

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.
 

Return to top