Add Comment For a Dispute

Path

POST /disputes/{disputeId}/comments

Request Parameters

disputeId

required

string <uuid>

unique identifier for the dispute which need to be updated

Request Body

application/json

body

string

Max length: 10000

The text of the comment. Can be omitted if only providing attachments as proof.

array

An optional list of previously uploaded attachment identifiers.

visibility

integer

Enum:

Internal = 1, Customer = 2, Merchant = 4

Responses

id

string

The unique identifier of the comment in uuid format.

disputeId

string

The identifier of the dispute the comment is associated with.

body

string

The text contents of the comment.
visibility
integer

Enum:
1
2
4

Internal = 1, Customer = 2, Merchant = 4
array

A list of files attached to the comment as evidence.

id

string

The unique identifier of the attachment.

fileName

string

The name for the attachment that has been generated for internal use.

originalFileName

string

The name that the attachment was originally uploaded with.

thumbnailUrl

string

If a thumbnail has been created, this will be the URL to it with a time-limited access token.

createdAt

string
yyyy-MM-ddTHH:mm:ss.fffffffzzz

When it was created.

size

integer

The number of bytes.

mimeType

string

The type of file content, e.g. image/jpeg.

originalFileUrl

string

The direct link to download the file.

malwareDetected

boolean

Unpopulated if the attachment has not been scanned yet. True if malware was detected, false if not.

object

The author of the comment.

name

string

clientName

string

firstName

string

lastName

string

email

string

name

string

name

string

firstName

string

lastName

string

email

string

name

string

createdAt

string
yyyy-MM-ddTHH:mm:ss.fffffffzzz

When the comment was created.
400 Invalid request
statusCode

integer

targetSite

object

message

string

data

object

innerException

object

helpLink

object

source

object

hResult

integer

stackTrace

object

200 Successful Request

Request Example

    
        {
 "body": "Attached is the proof of delivery",
 "attachments": [
  "244262c3-1d3f-4d2a-92c2-6d4aaa3fc828"
 ]
}

Response Example

    
        {
 "id": "28bf3f48-3e90-438d-722a-08ddb25b01d7",
 "body": "Attached is the proof of delivery",
 "author": {
  "$type": "Client",
  "clientName": "Example Client Inc6191"
 },
 "createdAt": "2025-06-23T13:36:49.7430971Z",
 "disputeId": "50fc9c37-cbcb-49f5-d72b-08dd939e9062",
 "attachments": [
  {
   "id": "244262c3-1d3f-4d2a-92c2-6d4aaa3fc828",
   "size": 1784046,
   "mimeType": "image/jpeg",
   "createdAt": "2025-06-24T08:17:00Z",
   "originalFileName": "Group_of_cats.jpg"
  }
 ]
}