How to get started
How to get started
Availability and the next steps needed to integrate with this API.
On this page
Available countries/ territories
The TradePay APIs currently support the markets listed below. Please speak to your HSBC representative for details.
| Region | Country/Territory |
|---|---|
| Asia Pacific | AU - Australia BD - Bangladesh CN - China HK - Hong Kong ID - Indonesia IN - India JP - Japan KR - South Korea LK - Sri Lanka MO - Macau MU - Mauritius MV - Maldives MY - Malaysia NZ - New Zealand PH - Philippines SG - Singapore TH - Thailand TW - Taiwan VN - Vietnam |
| Europe | BE - Belgium *Loan product not supported BM - Bermuda CH - Switzerland *Loan product not supported CZ - Czech Republic DE - Germany ES - Spain *Loan product not supported FR - France *Loan product not supported GB - United Kingdom Loan product not supported GR - Greece *Loan product not supported IE - Ireland IL - Israel IT - Italy LU - Luxembourg MT - Malta NL - Netherlands PL - Poland ZA - South Africa |
| Middle East | AE - United Arab Emirates DZ - Algeria EG - Egypt KW - Kuwait OM - Oman QA - Qatar SA - Saudi Arabia TR - Turkey |
| Americas | CA - Canada US - United States MX - Mexico BR - Brazil |
API availability
This API is for corporate customers of HSBC, or corporate partners operating a third party platform.
| API | Environment | |
|---|---|---|
| Live | Sandbox (Version 1) | |
| Submit TradePay Buyer Loan Application | ✅ | ✅ |
| Submit TradePay Buyer Loan Extension Request | ✅ | ✅ |
| Submit TradePay Buyer Loan Settlement Request | ✅ | ✅ |
| Request Trade Loan Status Summary List | ✅ | ✅ |
| Request Trade Loan Detail | ✅ | ✅ |
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