Skip to main content
POST
Create a dispute for a transaction

Authorizations

Api-Key
string
header
required

Path Parameters

transactionId
string<uuid>
required

Id of the transaction to create a dispute for

Body

application/json

The dispute to create

disputeType
enum<string>

The type of dispute being filed

Available options:
fraud,
creditNotProcessed,
serviceNotReceived,
merchandiseIssue,
other
textEvidence
string

The textual evidence for the dispute

Maximum string length: 65535
disputeAmount
integer

Disputed amount in cents. Must be less than or equal to the transaction amount. If omitted, defaults to the full transaction amount.

Required range: x >= 1

Response

Successful operation

id
string<uuid>
required

The dispute's unique identifier

transactionId
string<uuid>
required

The transaction's unique identifier

status
enum<string>
required

The status of the dispute

Available options:
pending,
inReview,
accepted,
rejected,
canceled,
resolvedByMerchant
disputeAmount
integer
required

Disputed amount in cents

createdAt
string<date-time>
required

The time at which the dispute was created

disputeType
enum<string>

The type of dispute

Available options:
fraud,
creditNotProcessed,
serviceNotReceived,
merchandiseIssue,
other
textEvidence
string

The textual evidence for the dispute

Maximum string length: 65535
resolvedAt
string<date-time>

The time at which the dispute was resolved

transaction
object

Details of the transaction associated with the dispute

hasFileEvidence
boolean

Indicates whether file evidence has been uploaded for the dispute

attachmentCount
integer

The number of attachments uploaded for the dispute

Required range: x >= 0