put https://api.sandbox.payments.stonex.com/api/v/investigation/
This endpoint can be used to update an investigation by adding a new comment.
- If you update an already OPEN investigation, then a new comment is added to the ongoing investigations and the status of the investigation will remain as OPEN
- If you update an investigation that is CLOSED, then the new comment is added to that investigation and the status will change from CLOSED to OPEN.
Request
URL: /api/v{version}/investigation/:supportTicketId
Method: PUT
Example Request
{
"description": "update investigation for testing"
}
Response
The successful response will contain the details of the investigation including any previous comments and file details.
Example Response
HTTP Status: 200 OK
{
"supportTicketId": "CS150420250803",
"createdBy": "Client ABC",
"createdDate": "2025-04-15T14:45:31.705Z",
"fxId": "123456789",
"topic": "Cancel",
"reason": "Hold Payment",
"status": "OPEN",
"messages": [
{
"createdBy": "Client ABC",
"createdDate": "2025-04-15T14:45:31.705Z",
"comment": "update investigation for testing",
"attachments": []
},
{
"createdBy": "StoneX Payments",
"createdDate": "2025-04-16T12:52:23.531Z",
"comment": "Working on this query, will provide an update soon",
"attachments": []
}
]
}
Error Scenario
When you do not provide any description in the API request, the endpoint will return an error.
{
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"errors": {
"Description": [
"The Description field is required."
]
},
"traceId": "00-148dfb5814f5cfdf1e125e7c7c72a43e-54a25fc4f90a970f-00"
}