| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Add a Comment to UW Task Ticket
Adds a text comment to a specific underwriting task (UW ticket) associated with a merchant. Comments are the primary communication mechanism between ISOs, merchants, and the underwriting team within a UW task. They can be used to ask questions, provide status updates, or log decisions related to the task.
Endpoint
POST /api/v1/uwTasks/ticket/addComment
Authentication
Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:
Authorization: Basic {base64(username:password)}
When to use
Use this endpoint when you need to communicate with the underwriting team about a specific task, or when the UW team needs to leave instructions for the ISO regarding required documentation. This is particularly useful after uploading new documents to explain what was provided, or to respond to an underwriter's request for clarification. Comments are timestamped and attributed to the authenticated user.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| id | integer (int32) | Yes | Merchant profile ID that owns the UW task |
| ticketId | integer (int32) | Yes | ID of the UW task ticket to add the comment to |
| text | string | Yes | The comment text to add to the ticket |
{
"id": 48201,
"ticketId": 1073,
"text": "We have uploaded the requested bank statements covering the past 3 months. Please let us know if additional documentation is needed."
}Response
200 OK
| Field | Type | Description |
|---|---|---|
| status | string (enum) | HTTP status name, e.g., "OK" |
| error | string | Error message if the operation failed |
| warning | string | Non-fatal warning message |
| validationResults | array | Field-level validation errors, if any |
| requestId | integer | Unique identifier for this API request |
{
"status": "OK",
"error": null,
"warning": null,
"validationResults": [],
"requestId": 88437
}Error Codes
| Code | When it happens |
|---|---|
| 400 | Required fields (id, ticketId, text) are missing or empty |
| 401 | Invalid or missing Basic Auth credentials |
| 403 | User does not have permission for this operation |
| 404 | Merchant or ticket not found |
| 500 | Internal server error |
Common Mistakes
- Omitting the
textfield or sending an empty string — all three fields are required. - Using the wrong
ticketId; UW tickets are distinct from general support tickets. Retrieve valid ticket IDs fromGET /api/v1/uwTasks/getByMerchantId. - Comments do not automatically notify the UW team that documents have been uploaded; for that, also call
POST /api/v1/uwTasks/setStatusInReview.
Related Endpoints
GET /api/v1/uwTasks/ticket/getCommentsByTicketId— retrieve all comments on a ticketGET /api/v1/uwTasks/getByMerchantId— get the list of UW task tickets for a merchantPOST /api/v1/uwTasks/ticket/addAttachment— attach a document to the same ticket
Example
curl -X POST https://hq.staging.netevia.dev/api/v1/uwTasks/ticket/addComment \
-H "Authorization: Basic $(echo -n 'username:password' | base64)" \
-H "Content-Type: application/json" \
-d '{
"id": 48201,
"ticketId": 1073,
"text": "We have uploaded the requested bank statements covering the past 3 months."
}'