put https://api.sandbox.payments.stonex.com/api/v1/investigation//close
This endpoint can be used by you to close an ongoing investigation using the supportTicketId in the request URL.
- If you close an OPEN investigation, then the status of the investigation is changed to CLOSED.
- If you close an already CLOSED investigation, then the endpoint will return an error (see below).
Request
URL: /api/v1/investigation/:supportTicketId/close
Method: PUT
Example Request
{
"description": "Closing this query as it has been resolved",
"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
When you close the investigation, the API will return a 202 Accepted message which means your request to close the investigation was successful.
Http code: 202 Accepted
Error Scenario
If you close an investigation that is already in a CLOSED status, the API will return an error as below:
{
"title": "Bad Input",
"status": 400,
"detail": "This investigation is already closed. Please check and enter a new investigation ID or reopen the investigation to query further",
"traceId": "00-ca5182fafd9fd5d2b78fd8a0a2e1348f-af311533e541ab2e-00",
"errorCode": "INV00005"
}