PayPal · Schema

Dispute Summary Information

The dispute summary information.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name	Type	Description
dispute_id	string	The ID of the dispute.
create_time	object	The date and time when the dispute was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For example, `yyyy`-`MM`-`dd``T``HH`:`mm`:`ss`.`SSS``
update_time	object	The date and time when the dispute was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For example, `yyyy`-`MM`-`dd``T``HH`:`mm`:`ss`.*`S
reason	object
status	object
dispute_state	object
dispute_amount	object	The amount in the transaction that the customer originally disputed. Because customers can sometimes dispute only part of the payment, the disputed amount might be different from the total gross or ne
dispute_asset	object	The asset in the transaction that the customer disputed.
dispute_life_cycle_stage	object
dispute_channel	object
buyer_response_due_date	object	The date and time by when the customer must respond to the dispute, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). If the customer does not respond by this date a
seller_response_due_date	object	The date and time by when the merchant must respond to the dispute, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). If the merchant does not respond by this date a
links	array	An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links/).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/dispute_info",
  "title": "Dispute Summary Information",
  "type": "object",
  "description": "The dispute summary information.",
  "properties": {
    "dispute_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "pattern": "^[A-Za-z0-9-]+$",
      "readOnly": true,
      "description": "The ID of the dispute."
    },
    "create_time": {
      "readOnly": true,
      "$ref": "#/components/schemas/date_time",
      "description": "The date and time when the dispute was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`."
    },
    "update_time": {
      "readOnly": true,
      "$ref": "#/components/schemas/date_time",
      "description": "The date and time when the dispute was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`."
    },
    "reason": {
      "$ref": "#/components/schemas/dispute_reason"
    },
    "status": {
      "readOnly": true,
      "$ref": "#/components/schemas/status"
    },
    "dispute_state": {
      "readOnly": true,
      "$ref": "#/components/schemas/dispute_state"
    },
    "dispute_amount": {
      "$ref": "#/components/schemas/money",
      "description": "The amount in the transaction that the customer originally disputed. Because customers can sometimes dispute only part of the payment, the disputed amount might be different from the total gross or net amount of the original transaction."
    },
    "dispute_asset": {
      "description": "The asset in the transaction that the customer disputed.",
      "$ref": "#/components/schemas/cryptocurrency"
    },
    "dispute_life_cycle_stage": {
      "readOnly": true,
      "$ref": "#/components/schemas/dispute_lifecycle_stage"
    },
    "dispute_channel": {
      "readOnly": true,
      "$ref": "#/components/schemas/dispute_channel"
    },
    "buyer_response_due_date": {
      "readOnly": true,
      "$ref": "#/components/schemas/date_time",
      "description": "The date and time by when the customer must respond to the dispute, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). If the customer does not respond by this date and time, the dispute is closed in the merchant's favor. For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`."
    },
    "seller_response_due_date": {
      "readOnly": true,
      "$ref": "#/components/schemas/date_time",
      "description": "The date and time by when the merchant must respond to the dispute, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). If the merchant does not respond by this date and time, the dispute is closed in the customer's favor. For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`."
    },
    "links": {
      "type": "array",
      "minItems": 1,
      "maxItems": 10,
      "description": "An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links/).",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/link_description",
        "readOnly": true
      }
    }
  }
}