Sign in

v1

latestOpenAPI 3.1.02026-07-2663312285.4 KB
Disputes

Post Message

Use this endpoint to post messages to a dispute when the POST MESSAGE capability is allowed

post/v1/disputes/{disputeId}/messages

Path parameters

disputeIdstring required

Dispute ID starting with 'dispute_' followed by 21 alpha-numeric characters.

Headers

Request-Referencestring

Optional Reference for the request. This is used to identify the request in debugging.

Request-Idempotency-Keystring

Optional Idempotency Key for the request. Sending duplicate requests will result in 409 HTTP status code.

Request body

contentstring required

The message content

Example request

{
  "content": "I have attached the requested documentation"
}

Response

Successfully posted the message for a dispute

contentstring required

The message content

sender'MERCHANT' | 'PROVIDER'

Sender of the message

phase'PRE_DISPUTE' | 'DISPUTE' | 'PRE_ARBITRATION' | 'ARBITRATION'

Phase of the dispute when message was created

createdAtstring date-time required

Date and time when the message was created

Example response

{
  "content": "We have reviewed your claim and require additional documentation",
  "createdAt": "2025-06-19T12:34:56.789Z"
}