put
https://api.sandbox.payments.stonex.com/api/v1/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/v1/investigation/:supportTicketId
Method: PUT
Example Request
{
"description": "provide an update - refer email",
"additionalDetails": {
"orderingInstitution": {
"name": "First Bank",
"contactInfo": [
{
"firstName": "Adam",
"lastName": "Bird",
"email": "[email protected]"
}
]
},
"instructingInstitution": {
"name": "Aspire Bank Ltd"
},
"userInfo": {
"createdBy": {
"contactInfo": {
"firstName": "John",
"lastName": "Scott",
"email": "[email protected]"
}
}
}
}
}Response
The successful response will contain the details of the investigation including any previous comments and file details.
Example Response
HTTP Status: 200 OK
{
"clientId": "ABC Bank",
"supportTicketId": "CS5100280091",
"createdBy": "John Scott",
"createdDate": "2025-05-21T11:07:12.066Z",
"fxId": "1234567",
"topic": "Modify",
"reason": "Incorrect Value Date",
"status": "OPEN",
"orderingInstitutionName": "First Bank",
"instructingInstitution": "Aspire Bank Ltd",
"messages": [
{
"createdBy": "John Scott",
"createdDate": "2025-05-21T11:07:12.066Z",
"comment": "please look into the transaction",
"attachments": [],
"orderingInstitutionName": "First Bank",
"instructingInstitution": "Aspire Bank Ltd"
},
{
"createdBy": "John Scott",
"createdDate": "2025-05-21T11:09:11.23Z",
"comment": "provide an update - refer email",
"attachments": [],
"orderingInstitutionName": "First Bank",
"instructingInstitution": "Aspire Bank Ltd"
}
]
}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"
}Internal Server Error