--- title: "List disputes" method: GET path: "/v1/customer/disputes" tags: ["disputes"] --- # List disputes `GET /v1/customer/disputes` Lists disputes with a summary set of details, which shows the dispute_id, reason, status, dispute_state, dispute_life_cycle_stage, dispute_channel, dispute_amount, create_time and update_time fields.

To filter the disputes in the response, specify one or more optional query parameters. To limit the number of disputes in the response, specify the page_size query parameter.

To list multiple disputes, set these query parameters in the request:
If the response contains more than two disputes, it lists two disputes and includes a HATEOAS link to the next page of results. ## Query parameters - `start_time` string - `disputed_transaction_id` string - `page_size` integer - `next_page_token` string - `dispute_state` 'REQUIRED_ACTION' | 'REQUIRED_OTHER_PARTY_ACTION' | 'UNDER_PAYPAL_REVIEW' | 'RESOLVED' | 'OPEN_INQUIRIES' | 'APPEALABLE' - `update_time_before` string - `update_time_after` string ## Response `200` 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. - DisputeSearch — An array of disputes. Includes links that enable you to navigate through the response. - `items` DisputeInfo[] — An array of disputes that match the filter criteria. Sorted in latest to earliest creation time order. - `dispute_id` string — The ID of the dispute. - `create_time` string, ppaas_date_time_v3 — The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
- `update_time` string, ppaas_date_time_v3 — The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
- `reason` 'MERCHANDISE_OR_SERVICE_NOT_RECEIVED' | 'MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED' | 'UNAUTHORISED' | 'CREDIT_NOT_PROCESSED' | 'DUPLICATE_TRANSACTION' | 'INCORRECT_AMOUNT' | 'PAYMENT_BY_OTHER_MEANS' | 'CANCELED_RECURRING_BILLING' | 'PROBLEM_WITH_REMITTANCE' | 'OTHER' — The reason for the item-level dispute. For information about the required information for each dispute reason and associated evidence type, see dispute reasons. - `status` 'ACTIVE' | 'INACTIVE' — Status of the payment resource. - `dispute_state` 'OPEN_INQUIRIES' | 'REQUIRED_ACTION' | 'REQUIRED_OTHER_PARTY_ACTION' | 'UNDER_PAYPAL_REVIEW' | 'APPEALABLE' | 'RESOLVED' — The user specific state of the dispute, could vary between parties during the dispute lifecycle. - `dispute_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due. - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency. - `value` string, required — The value, which might be:For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/). - `dispute_asset` Cryptocurrency — The details needed to represent a specific cryptocurrency balance, such as its symbol and quantity. - `asset_symbol` 'BTC' | 'ETH' | 'BCH' | 'LTC' | 'PYUSD' | 'LINK' | 'SOL' | 'MATIC', required — The cryptocurrency symbol or code ticker options. Assigned by liquidity providers and exchanges. - `quantity` string, required — The quantity of a cryptocurrency asset. This is a decimal number with a scale defined for each cryptocurrency by its founders. For example, Bitcoin (BTC) has 8 as its scale, Ethereum (ETH) has 18 as its scale. The PayPal Cryptocurrency platform handles the scale to 8 digits for Bitcoin. including its forks or offshoots, as well as Ethereum. - `quantity_in_subunits` string — The quantity of a cryptocurrency asset in the currency's sub units.
Amount is an integer in a string format.
Floating point should be avoided to avoid precision errors. For example:
  • Bitcoin(BTC) has 8 decimals,
    • so 1 BTC will be represented as 100000000 (1 followed by 8 zeroes).
  • Ethereum(ETH) has 18 decimals,
    • so 1 ETH will be represented as 1000000000000000000 (1 followed by 18 zeroes). - `decimals` integer — The number of decimal digits supported by this cryptocurrency. For example, for Bitcoin this value is 8 because there are 10^8 satoshis in one Bitcoin and for Ethereum it's 18 since there are 10^18 wei in one Ether. - `dispute_life_cycle_stage` 'INQUIRY' | 'CHARGEBACK' | 'PRE_ARBITRATION' | 'ARBITRATION' — The stage in the dispute lifecycle. - `dispute_channel` 'INTERNAL' | 'EXTERNAL' | 'ALERT' — The channel where the customer created the dispute. - `buyer_response_due_date` string, ppaas_date_time_v3 — The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.
    Note: The regular expression provides guidance but does not reject all invalid dates.
    - `seller_response_due_date` string, ppaas_date_time_v3 — The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.
    Note: The regular expression provides guidance but does not reject all invalid dates.
    - `links` LinkDescription[] — An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links/). - `href` string, required — The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call. - `rel` string, required — The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml). - `method` 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'CONNECT' | 'OPTIONS' | 'PATCH' — The HTTP method required to make the related call. - `links` LinkDescription[] — An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links/). - `href` string, required — The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call. - `rel` string, required — The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml). - `method` 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'CONNECT' | 'OPTIONS' | 'PATCH' — The HTTP method required to make the related call. ## Other responses - `400` — The request failed due to a validation error. The request returns the HTTP `400 Bad Request` status code. - `default` — The error response. --- [API](https://skmtc.net/paypal/apis/payments.md) · [All operations](https://skmtc.net/paypal/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paypal/payments/revisions/672aceee1190/schema)