View as Markdown

Transactions Service API

Base URL: https://interact-uat.hsbc.com/yi-transactions-service/
GET /v2/transactions/history

Get v2 transaction history

Returns paginated Open Banking-mapped transactions for a single account in the standard data/meta envelope. Set includeRawHSBCnetData=true to include raw source fields in each transaction. Use header test: 1 to return seeded in-memory data instead of calling the upstream service. Customer IDs mapped in the internal test-data hashmap are served from test-data-viewer automatically and mapped back to the same response shape.

Requires authentication: neoSessionCookie (cookie) or xHSBCCustIdHeader (header) or b2bBearerToken (header)

Parameters

NameInDescription
X-HSBC-Account-Id required
string
header HSBC account identifier for the requested transaction history.
X-HSBC-Account-Currency
string
header Optional account currency used to label returned amounts.
X-HSBC-Request-Correlation-Id
string
header Optional caller-provided correlation identifier.
X-HSBC-CUSTID
string
header Customer identifier used for the customer-id header authentication journey.
test
string
header Set to 1 to serve seeded in-memory data instead of calling the upstream transaction-history service.
offset
integer
query Zero-based starting index for pagination.
limit
integer
query Maximum number of records to return.
includeRawHSBCnetData
boolean
query When true, includes a normalized raw HSBCnet data object in each mapped transaction.
lookbackDays
integer
query Number of days of transaction history to request.

Responses

  • 200 Transactions retrieved successfully
  • 400 Invalid request parameters or missing required headers.
  • 401 Missing or invalid authentication.
  • 403 Caller is authenticated but not entitled for the requested account.
  • 500 Unexpected service failure.
  • 502 Downstream transaction-history service returned an invalid or failing response.