Resources
This page documents the JSON:API resource schemas related to disputes.
Dispute
The Dispute resource represents a card dispute that has been raised by an end customer.
For the complete resource schema including all attributes and relationships, see Dispute.
Key Attributes
| Attribute | Type | Description |
|---|---|---|
| source | string | The source of the dispute (e.g., DebitCard). |
| status | string | The current status of the dispute: InvestigationStarted, ProvisionalCredit, ResolvedWon, ResolvedLost, or Denied. |
| statusHistory | array | Array of status change records with type and updatedAt timestamps. |
| description | string | Description of the disputed transaction. |
| disputeType | string | The type of dispute (e.g., Fraud, Unauthorized). |
| amount | integer | The disputed amount (in cents). |
| createdAt | RFC3339 Date string | The date the dispute was created. |
| decisionReason | string | Optional. The reason for the dispute decision, if resolved. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| customer | Customer | The customer who filed the dispute. |
| account | DepositAccount | The account associated with the disputed transaction. |
| transaction | Transaction | The disputed transaction. |
| card | Card | The card used in the disputed transaction. |