POST
/
disputes
Create a dispute for a usage event
curl --request POST \
  --url https://api.paygentic.io/v0/disputes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "usageEventId": "<string>",
  "message": "<string>"
}'
{
  "id": "<string>",
  "object": "dispute",
  "usageEventId": "<string>",
  "customerId": "<string>",
  "merchantId": "<string>",
  "customerMessage": "<string>",
  "merchantMessage": "<string>",
  "status": "pending",
  "disputedAmount": "<string>",
  "resolvedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key authentication

Body

application/json
usageEventId
string
required

ID of the usage event to dispute

message
string
required

Customer's reason for the dispute (minimum 10 characters to prevent spam)

Required string length: 10 - 1000

Response

Dispute created successfully

id
string
required

Unique identifier for a dispute

object
enum<string>
default:dispute
required
Available options:
dispute
usageEventId
string
required

The usage event being disputed

customerId
string
required

Customer who filed the dispute

merchantId
string
required

Merchant associated with the dispute

customerMessage
string
required

Customer's reason for the dispute

status
enum<string>
required

Current status of the dispute

Available options:
pending,
accepted,
declined
disputedAmount
string<decimal>
required

Amount being disputed (in dollars)

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
merchantMessage
string | null

Merchant's response to the dispute

resolvedAt
string<date-time> | null

When the dispute was resolved