Trade Finance - Document Managements
Trade Finance - Document Managements

On this page

API Information

Trade Finance - Document Management

  • Version: v3 
  • Protocol: HTTPS
  • URL Pre-Prod Test (UAT): Please speak to your Client Integration contact
  • URL Production: Please speak to your Client Integration contact

Description

In this document, you'll find the steps your organization needs to take to use our API services. Also in this guide are details of request and response messages used to support your organization’s integration.

The intended audience for this document are Technical Architects, Development Engineers, Test Engineers, and Operation & Maintenance Engineers involved in development and support of your organization’s integration.

Setting up our API Services is best completed with the assistance of your organization’s IT team, or someone with experience and knowledge of application programming interfaces. This should include experience with - JSON payloads and security and public key infrastructure (PKI).

Getting Started

Topics This page will help you to: Reference 
API Specification
  1. Description of API headers, request and response body
View specification (OAS)
View specification (PDF)
Securing your Connection and Data
  1. Understand the steps required to secure and encrypt a connection with HSBC
  2. View the fields to be provided in the JWT header and payload
  3. See code examples of how to generate the required JSON Web Token (JWT)
View
Making an API Request
  1. Prepare an API request payload and perform payload encryption
  2. Generate and sign a client token (JWT)
  3. Steps required to process a response
View
Response Codes and Formats
  1. Understand the response code
  2. How to perform troubleshooting
View
Sandbox Access
  1. Perform Testing on Sandbox
 Coming Soon

Version History

Change log and release history:

Version Release Date Status Description
v3 March 2024 Live Trade Finance - Document Managements 

 

Return to top

© HSBC Bank plc 2024