Corporate Sandbox Management

Description

The Sandbox Management API is available to upload test data files and reset the sandbox directly from your development environment. This is applicable for both HSBC Bank and HSBC Innovation Banking.

• POST/DELETE https://sandbox.corporate-api.hsbc.com/v1/sandbox-self-service/data
• POST method adds rows to the table defined in the header table-name
• DELETE resets the sandbox table defined in the header table-name to the default dataset.

See also:

Detailed User Guide for Sandbox projects

Download the Sandbox Toolkit

Detailed Guide to Sandbox Data Management

Postman Collection

The below collection can be downloaded to perform the upload and rest commands for both account and transaction table via Postman:

Sandbox Management APIs.postman_collection.zip

Code Examples

Sample cURL snippets for the Sandbox Management API:

Below cURL snippet can be used to add data to the transaction table.

curl --location --request POST 'https://sandbox.corporate-api.hsbc.com/v1/sandbox-self-service/data' \ --header 'x-hsbc-client-id: {{client-id}}' \ --header 'x-hsbc-client-secret: {{client-secret}}' \ --header 'x-hsbc-profile-id: {{profile-id}}' \ --header 'product-category: treasury' \ --header 'category-version: 1.0' \ --header 'api-name: account-information' \ --header 'api-version: v2' \ --header 'table-name: transaction' \ --header 'product-names: account-information-v2' \ --header 'content-type: multipart/form-data' \ --f file=@/{{your-upload-file-location-and-filename}}

Below cURL snippet can be used to reset the data in the transaction table back to the default dataset.

curl --location --request DELETE 'https://sandbox.corporate-api.hsbc.com/v1/sandbox-self-service/data' \ --header 'x-hsbc-client-id: {{client-id}}' \ --header 'x-hsbc-client-secret: {{client-secret}}' \ --header 'x-hsbc-profile-id: {{profile-id}}' \ --header 'product-category: treasury' \ --header 'category-version: 1.0' \ --header 'api-name: account-information' \ --header 'api-version: v2' \ --header 'table-name: transaction' \ --header 'product-names: account-information-v2'

Version History

Change log and release history:

Return to top