Skip to main content

Documentation Index

Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt

Use this file to discover all available pages before exploring further.

The Dispute Data Model represents a contact dispute or chargeback on a payment transaction. Disputes occur when contacts contest charges with their bank or card issuer.
  • Chargeback management: Track disputes from filing through resolution
  • Evidence tracking: Monitor evidence submission deadlines
  • Reason categorization: Standardized dispute reason codes
  • Transaction linking: Connect disputes to original payment transactions

​
Attributes

​
Dispute Attributes

PropertyTypeDescription
rootfi_idintegerUnique identifier for this dispute
rootfi_created_atstringWhen this dispute was created in Commenda’s system (ISO 8601)
rootfi_updated_atstringWhen this dispute was last updated (ISO 8601)
rootfi_company_idintegerCompany identifier this dispute belongs to
platform_idstringPlatform-specific dispute identifier
transaction_idstringReference to the disputed Transaction
invoice_idstringReference to the related Invoice
contact_idstringReference to the Contact
currency_idstringISO 4217 currency code
amountnumberDisputed amount
statusenumCurrent dispute status
reasonenumStandardized dispute reason
reason_codestringPlatform-specific reason code
gatewaystringPayment gateway name
gateway_dispute_idstringPlatform-specific dispute ID
evidence_due_datestringDeadline for submitting evidence (ISO 8601)
resolution_datestringDate dispute was resolved (null if pending) (ISO 8601)
created_atstringOriginal dispute creation timestamp (ISO 8601)
updated_atstringLast update timestamp (ISO 8601)

​
Status Enum Values

ValueDescription
OPENDispute has been filed and is open
UNDER_REVIEWPlatform is reviewing evidence
WONMerchant won the dispute
LOSTContact won the dispute
WARNING_CLOSEDClosed with a warning
UNKNOWNStatus cannot be determined

​
Reason Enum Values

ValueDescription
FRAUDULENTTransaction was fraudulent
DUPLICATEDuplicate charge
UNRECOGNIZEDContact doesn’t recognize transaction
QUALITY_ISSUEProduct/service quality issue
NOT_RECEIVEDProduct not received
CANCELEDService was canceled
OTHEROther reason

​
Expandable Attributes

Use the expand query parameter to include related objects:
  • expand=transaction - Includes the disputed Transaction object
  • expand=invoice - Includes the related Invoice object
  • expand=contact - Includes the Contact object
{
  "rootfi_id": 10001,
  "rootfi_created_at": "2025-01-20T00:00:00Z",
  "rootfi_updated_at": "2025-01-25T14:00:00Z",
  "rootfi_company_id": 999,
  "platform_id": "dp_stripe_001",
  "transaction_id": "9001",
  "invoice_id": "54321",
  "contact_id": "12345",
  "currency_id": "USD",
  "amount": 500.00,
  "status": "UNDER_REVIEW",
  "reason": "UNRECOGNIZED",
  "reason_code": "customer_not_recognized",
  "gateway": "stripe",
  "gateway_dispute_id": "dp_stripe_12345",
  "evidence_due_date": "2025-02-05T00:00:00Z",
  "resolution_date": null,
  "created_at": "2025-01-20T00:00:00Z",
  "updated_at": "2025-01-25T14:00:00Z"
}