Payment Event History

Returns the event history for a single payment instruction. The account, payment type, and direction are supplied in the request body and checked against the authenticated customer's entitlements.

Parameters

Name	In	Description
X-HSBC-Request-Correlation-Id string	header	Optional trace identifier forwarded to downstream services and recorded in logs. Include this value when raising support requests. A UUID is recommended; auto-generated when not supplied.

Request Body application/json

Field	Description
uetr string	UETR of the payment instruction. At least one of `uetr` or `payId` must be provided.
payId string	Payment identifier. At least one of `uetr` or `payId` must be provided.
paymentDirection required string	`OW` = outward; `IW` = inward.
paymentType string	Required when `paymentDirection` is `OW`.
account required object
reference string
msgtype string

Responses

200 The event history for the requested payment instruction
400 Invalid request — for example, both uetr and payId are absent, paymentDirection is not OW or IW, or required account fields are missing
401 Missing or invalid NEO session
403 The authenticated customer is not entitled to view events for the requested account
429 Too many requests — rate limit exceeded
500 Unexpected server error
503 The payment event service is temporarily unavailable

curl -X POST "https://interact-uat.hsbc.com/payment-service/api/v0/payment-instructions/events" \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "X-HSBC-Request-Correlation-Id: YOUR_X_HSBC_REQUEST_CORRELATION_ID" \ -H "Content-Type: application/json" \ -d '{ ... }'

const response = await fetch("https://interact-uat.hsbc.com/payment-service/api/v0/payment-instructions/events", { method: "POST", headers: { "Authorization": "Bearer YOUR_TOKEN", "X-HSBC-Request-Correlation-Id": "YOUR_X_HSBC_REQUEST_CORRELATION_ID" }, body: JSON.stringify({ /* ... */ }), }); const data = await response.json();

import requests url = "https://interact-uat.hsbc.com/payment-service/api/v0/payment-instructions/events" headers = { "Authorization": "Bearer YOUR_TOKEN", "X-HSBC-Request-Correlation-Id": "YOUR_X_HSBC_REQUEST_CORRELATION_ID", } response = requests.post(url, headers=headers, json={ # ... }) print(response.json())

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://interact-uat.hsbc.com/payment-service/api/v0/payment-instructions/events")) .header("Authorization", "Bearer YOUR_TOKEN") .header("X-HSBC-Request-Correlation-Id", "YOUR_X_HSBC_REQUEST_CORRELATION_ID") .POST(HttpRequest.BodyPublishers.ofString("{ ... }")) .build(); HttpResponse<String> response = client.send( request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());