Affirm · Schema

Dispute

Represents a payment dispute filed by a customer against an Affirm transaction, including its current status, reason, and any evidence submitted by the merchant.

FintechBNPLLendingPaymentsConsumer

Properties

Name	Type	Description
id	string	Unique identifier for this dispute.
transaction_id	string	The identifier of the Affirm transaction being disputed.
charge_id	string	The identifier of the charge associated with this dispute.
status	string	Current status of the dispute.
reason_code	string	Standardized reason code categorizing the nature of the dispute (e.g., item_not_received, item_not_as_described, unauthorized).
amount	integer	The disputed amount in cents.
currency	string	ISO 4217 currency code for the disputed amount.
created	string	Timestamp when this dispute was created, in RFC 3339 format.
evidence_due_by	string	Deadline by which the merchant must submit evidence to contest this dispute, in RFC 3339 format.
closed_at	string	Timestamp when this dispute was closed, if applicable.
outcome	string	Final outcome of the dispute after review. Only set when status is won or lost.
evidence	array	List of evidence items submitted by the merchant for this dispute.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/affirm/refs/heads/main/json-schema/disputes-dispute-schema.json",
  "title": "Dispute",
  "description": "Represents a payment dispute filed by a customer against an Affirm transaction, including its current status, reason, and any evidence submitted by the merchant.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for this dispute.",
      "example": "500123"
    },
    "transaction_id": {
      "type": "string",
      "description": "The identifier of the Affirm transaction being disputed.",
      "example": "500123"
    },
    "charge_id": {
      "type": "string",
      "description": "The identifier of the charge associated with this dispute.",
      "example": "500123"
    },
    "status": {
      "type": "string",
      "description": "Current status of the dispute.",
      "enum": [
        "open",
        "closed",
        "won",
        "lost"
      ],
      "example": "open"
    },
    "reason_code": {
      "type": "string",
      "description": "Standardized reason code categorizing the nature of the dispute (e.g., item_not_received, item_not_as_described, unauthorized).",
      "example": "example_value"
    },
    "amount": {
      "type": "integer",
      "description": "The disputed amount in cents.",
      "example": 1
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code for the disputed amount.",
      "example": "USD"
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when this dispute was created, in RFC 3339 format.",
      "example": "2025-03-15T14:30:00Z"
    },
    "evidence_due_by": {
      "type": "string",
      "format": "date-time",
      "description": "Deadline by which the merchant must submit evidence to contest this dispute, in RFC 3339 format.",
      "example": "2025-03-15T14:30:00Z"
    },
    "closed_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Timestamp when this dispute was closed, if applicable.",
      "example": "2025-03-15T14:30:00Z"
    },
    "outcome": {
      "type": "string",
      "nullable": true,
      "description": "Final outcome of the dispute after review. Only set when status is won or lost.",
      "enum": [
        "merchant_won",
        "merchant_lost"
      ],
      "example": "merchant_won"
    },
    "evidence": {
      "type": "array",
      "description": "List of evidence items submitted by the merchant for this dispute.",
      "items": {
        "$ref": "#/components/schemas/EvidenceItem"
      },
      "example": [
        "example_value"
      ]
    }
  }
}