Skip to main content

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

AttributeTypeDescription
sourcestringThe source of the dispute (e.g., DebitCard).
statusstringThe current status of the dispute: InvestigationStarted, ProvisionalCredit, ResolvedWon, ResolvedLost, or Denied.
statusHistoryarrayArray of status change records with type and updatedAt timestamps.
descriptionstringDescription of the disputed transaction.
disputeTypestringThe type of dispute (e.g., Fraud, Unauthorized).
amountintegerThe disputed amount (in cents).
createdAtRFC3339 Date stringThe date the dispute was created.
decisionReasonstringOptional. The reason for the dispute decision, if resolved.

Relationships

RelationshipTypeDescription
customerCustomerThe customer who filed the dispute.
accountDepositAccountThe account associated with the disputed transaction.
transactionTransactionThe disputed transaction.
cardCardThe card used in the disputed transaction.