How to get started

How to get started

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


Coverage details

Virtual Account API’s are available in the below countries 

  • Virtual Account Creation:  Sri Lanka, Vietnam, Hong Kong, United States, United Kingdom, Netherlands
  • Virtual Account Maintenance:  Sri Lanka, Vietnam, Hong Kong, United States, United Kingdom, Netherlands
  • VA balance and transaction Inquiry: Netherlands, United States, United Kingdom, Hong Kong, Australia, UAE

Eligibility

This API is available for Commercial banking, Global banking and Non-Banking Financial Institution customers. For Business banking customers, please speak to your HSBC representative to confirm availability.


Getting started

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

  • Please speak to a member of our Global Payments solution team or your existing HSBC representative.
  • Following a discussion with your HSBC representative you will be allocated a client integration manager who will guide you through the process of integrating with our APIs.
  • Your organisation will be registered on this site and you will receive an invitation to access the implementation documentation for the APIs.
  • Please read our documentation on how to use the HSBC API services and secure your connection with the relating electronic certificate and encryption key.
  • You will be guided on how to access the correct test environment to test your applications connectivity and integration with our APIs.
  • Your client integration contact will assist with testing and confirm when you are ready to go-live.
  • In the event of something going wrong during API testing, please contact your client integration manager in the first instance.
  • For any issues with the Developer Portal please raise a support ticket from the Help menu.

 

 

 

Return to top