How to get started

How to get started

Availability and the next steps needed to integrate with this API.


Available countries/ territories

The Supply Chain Finance APIs currently support the locations listed below. For more details, please speak to your HSBC representative.

Region Country/Territory
Asia Pacific AU - Australia
BD - Bangladesh
CN - China
HK - Hong Kong
IN - India
JP - Japan
MY - Malaysia
SG - Singapore
TH - Thailand
TW - Taiwan
VN - Vietnam
Europe FR - France
GB - United Kingdom
Middle East AE - United Arab Emirates
Americas CA - Canada

API availability

This API is for corporate customers of HSBC, or corporate partners operating a third party platform.

API Environment
Live Sandbox
Submit Supplier On-boarding Application Coming Soon
Request Supplier On-boarding Status Coming Soon
Submit Approved Invoices'
Request Invoices' Summary List

For more details on eligibility for this API, please speak to our Trade Finance team .


Getting started

Getting started is really simple! Please follow these steps to start working with our APIs:

  • Refer to API Security at HSBC to find out more about HSBC API Security Schemes.
  • Register for a Corporate account to get access to the documentation and sandbox environments.
  • Once you have registered, Find the APIs that meet your requirements and read the Documentation.
  • Review the API Specification under Endpoints for suitability of your business needs.
  • Review Documentation for technical details.
    Documentation\Left Menu Left Menu Item
    Refer to API Information for overview
    Refer to Securing a Connection to understand details of HSBC API Security schemas
    Refer to Making an API Request for step-by-step tutorials
    Refer to Response Codes and Formats for understanding and troubleshoots
    Refer to Sandbox Access for usage of the Corporate sandbox to build your integration and test connectivity
  • Once you are happy with how our APIs work, create a sandbox project under Dev Hub.
  • Refer to Sandbox Access for usage of the Corporate sandbox to build your integration and test connectivity
  • In the event of something going wrong during API testing, please send a support ticket via Contact Us.

Go Live

  • Refer to Go Live for steps on generating security credentials for HSBC API Connectivity in live environment
  • Contact our Client Integration Team where a Client Integration Manager will be allocated to guide you through on-boarding and set up in our managed test environments and support connectivity to the live APIs

 

Related article: Get started - Corporate Banking APIs

Return to top

Next: Registration