Affirm · JSON Structure

Disputes Dispute Structure

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: 12
FintechBNPLLendingPaymentsConsumer

Dispute is a JSON Structure definition published by Affirm, describing 12 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id transaction_id charge_id status reason_code amount currency created evidence_due_by closed_at outcome evidence

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

disputes-dispute-structure.json Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/affirm/refs/heads/main/json-structure/disputes-dispute-structure.json",
  "name": "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": "int32",
      "description": "The disputed amount in cents.",
      "example": 1
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code for the disputed amount.",
      "example": "USD"
    },
    "created": {
      "type": "datetime",
      "description": "Timestamp when this dispute was created, in RFC 3339 format.",
      "example": "2025-03-15T14:30:00Z"
    },
    "evidence_due_by": {
      "type": "datetime",
      "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": "datetime",
      "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"
      ]
    }
  }
}