Skip to main content
GET
/
v1
/
customer
/
disputes
List disputes
curl --request GET \
  --url https://api-m.sandbox.paypal.com/v1/customer/disputes \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "dispute_id": "<string>",
      "create_time": "<string>",
      "update_time": "<string>",
      "reason": "MERCHANDISE_OR_SERVICE_NOT_RECEIVED",
      "status": "OPEN",
      "dispute_state": "OPEN_INQUIRIES",
      "dispute_amount": {
        "currency_code": "<string>",
        "value": "<string>"
      },
      "dispute_asset": {
        "asset_symbol": "BTC",
        "quantity": "<string>",
        "quantity_in_subunits": "<string>",
        "decimals": 20
      },
      "dispute_life_cycle_stage": "INQUIRY",
      "dispute_channel": "INTERNAL",
      "buyer_response_due_date": "<string>",
      "seller_response_due_date": "<string>",
      "links": [
        {
          "href": "<string>",
          "rel": "<string>",
          "method": "GET"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "<string>",
      "rel": "<string>",
      "method": "GET"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Oauth 2.0 authentication

Query Parameters

​
start_time
string
default:Current date and time

Filters the disputes in the response by a creation date and time. The start time must be within the last 180 days. Value is in Internet date and time format. For example, yyyy-MM-ddTHH:mm:ss.SSSZ.

You can specify either but not both the start_time and disputed_transaction_id query parameters.

Required string length: 20 - 64
​
disputed_transaction_id
string

Filters the disputes in the response by a transaction, by ID.

You can specify either but not both the start_time and disputed_transaction_id query parameter.

Required string length: 1 - 255
​
page_size
integer
default:10

Limits the number of disputes in the response to this value.

Required range: 1 <= x <= 50
​
next_page_token
string
default:The first page of data

The token that describes the next page of results to fetch. The list disputes call returns this token in the HATEOAS links in the response.

Required string length: 1 - 255
​
dispute_state
enum<string>

Filters the disputes in the response by a state. Separate multiple values with a comma (,). When you specify more than one dispute_state, the response lists disputes that belong to any of the specified dispute_state.

Available options:
REQUIRED_ACTION,
REQUIRED_OTHER_PARTY_ACTION,
UNDER_PAYPAL_REVIEW,
RESOLVED,
OPEN_INQUIRIES,
APPEALABLE
Required string length: 1 - 2000
​
update_time_before
string

The date and time when the dispute was last updated, in Internet date and time format. For example, yyyy-MM-ddTHH:mm:ss.SSSZ. update_time_before must be within the last 180 days and the default is the current time.

Required string length: 20 - 64
​
update_time_after
string

The date and time when the dispute was last updated, in Internet date and time format. For example, yyyy-MM-ddTHH:mm:ss.SSSZ. update_time_after must be within the last 180 days and the default is the maximum time (180 days) supported.

Required string length: 20 - 64

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that lists disputes with a full or summary set of details. Default is a summary set of details, which shows the dispute_id, reason, status, dispute_amount, create_time, and update_time fields for each dispute.

An array of disputes. Includes links that enable you to navigate through the response.

​
items
Dispute Summary Information · object[]

An array of disputes that match the filter criteria. Sorted in latest to earliest creation time order.

Required array length: 1 - 100 elements
​
links
Link Description · object[]

An array of request-related HATEOAS links.

Required array length: 1 - 10 elements