---
title: "List disputes"
method: GET
path: "/disputes"
tags: ["Settlement"]
---

# List disputes

`GET /disputes`

Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of disputes.  

Use query parameters to filter the list of results that we return, for example, to search for disputes linked to a specific merchant.  

> **Important:** You must provide a value for the date query parameter.  

Our gateway returns the following information about each dispute in the list:  
- Its status, type, and description.  
- Transaction that the dispute is linked to, including the transaction date, merchant who ran the transaction, and the payment method that the cardholder used.

## Query parameters

- `before` string
- `after` string
- `limit` integer
- `date` string, date, required
- `merchantId` string

## Headers

- `Authorization` string, required

## Response `200`

Successful request. Returns a paginated list of disputes.

- ReportingSettlementListDisputesResponse200 — Contains the pagination properties that you use to navigate through a list of results.
  - `limit` integer — Maximum number of results that we return for each page.
  - `count` integer — Number of results we returned on this page. **Note:** This might not be the total number of results that match your query.
  - `hasMore` boolean — Indicates whether there is another page of results available.
  - `links` Link[] — Reference links to navigate to the previous page of results or to the next page of results.
    - `rel` string, required — Indicates the relationship between the current resource and the target resource.
    - `method` string, required — HTTP method that you need to use with the target resource.
    - `href` string, required — URL of the target resource.
  - `data` Dispute[], required — Array of dispute objects.
    - `disputeId` integer — Unique identifier that we assigned to the dispute.
    - `disputeType` 'prearbitration' | 'issuerReversal' | 'firstDisputeWithReversal' | 'firstDispute' — Type of dispute.
    - `currentStatus` DisputeCurrentStatus — Object that contains information about the current status of the dispute.
      - `disputeStatusId` integer — Unique identifier that we assigned to the status of the dispute.
      - `status` 'prearbitrationInProcess' | 'prearbitrationAccepted' | 'prearbitrationDeclined' | 'arbitrationFiledWithCardBand' | 'arbitrationFundsToBeReturned' | 'arbitrationLost' | 'arbitrationSettledPartialAmount' | 'precomplianceInProcess' | 'precomplianceAccepted' | 'precomplianceDeclined' | 'complianceFiledWithCardBand' | 'complianceLost' | 'complianceSettledPartialAmount' | 'invalid' | 'issuerReversal' | 'new' | 'rejected' | 'representmentInProgress' | 'representmentFailed' | 'representmentPaid' | 'representmentReceived' | 'stand' — Status of the dispute. **Note:** If you want to view the status history of the dispute, use our [List Dispute Statuses](https://docs.payroc.com/api/schema/reporting/settlement/list-disputes-statuses) method.
      - `statusDate` string, date — Date that the status of the dispute was last changed. The format of this value is **YYYY-MM-DD**.
      - `link` Link — Object that contains HATEOAS links for the resource.
        - `rel` string, required — Indicates the relationship between the current resource and the target resource.
        - `method` string, required — HTTP method that you need to use with the target resource.
        - `href` string, required — URL of the target resource.
    - `createdDate` string, date — Date that we received the dispute. The format of this value is **YYYY-MM-DD**.
    - `lastModifiedDate` string, date — Date that the dispute was last changed. The format of this value is **YYYY-MM-DD**.
    - `receivedDate` string, date — Date that the acquiring bank received the dispute. The format of this value is **YYYY-MM-DD**.
    - `description` string — Description of the dispute.
    - `referenceNumber` string — Reference number from the acquiring bank.
    - `disputeAmount` integer — Dispute amount. We return the value in the currency's lowest denomination, for example, cents.
    - `feeAmount` integer — Value of the fees for the dispute. We return the value in the currency's lowest denomination, for example, cents.
    - `firstDispute` boolean — Indicates if this is the first dispute for the transaction.
    - `authorizationCode` string — Authorization code of the transaction that the dispute is linked to.
    - `currency` string — Currency of the transaction that the dispute is linked to. The value for the currency follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.
    - `card` CardSummary — Object that contains information about the card.
      - `cardNumber` string — Masked card number. Our gateway shows only the first six digits and the last four digits of the card number, for example, `500165******0000`.
      - `type` 'visa' | 'masterCard' | 'discover' | 'debit' | 'ebt' | 'wrightExpress' | 'voyager' | 'amex' | 'privateLabel' | 'storedValue' | 'discoverRetained' | 'jcbNonSettled' | 'dinersClub' | 'amexOptBlue' | 'fuelman' | 'unknown' — Card type, for example, Visa. **Note:** If we can’t match a dispute to a transaction, we don’t return a type object.
      - `cvvPresenceIndicator` boolean — Indicates whether the cardholder provided the Card Verification Value (CVV).
      - `avsRequest` boolean — Indicates whether the merchant used the Address Verification Service (AVS) to verify the cardholder's address.
      - `avsResponse` string — Response from the Address Verification Service (AVS).
    - `merchant` MerchantSummary — Object that contains information about the merchant.
      - `merchantId` string — Unique identifier that the processor assigned to the merchant.
      - `doingBusinessAs` string — Trading name of the business.
      - `processingAccountId` integer — Unique identifier that we assigned to the processing account.
      - `link` Link — Object that contains HATEOAS links for the resource.
        - `rel` string, required — Indicates the relationship between the current resource and the target resource.
        - `method` string, required — HTTP method that you need to use with the target resource.
        - `href` string, required — URL of the target resource.
    - `transaction` TransactionSummary — Object that contains summary information about the transaction that the dispute is linked to.
      - `transactionId` integer, nullable — Unique identifier of the transaction. If we can't match a dispute to a transaction, we don't return the transactionId or link object.
      - `type` 'capture' | 'return' — Indicates the type of transaction.
      - `date` string, date — Date of the transaction. The format of this value is **YYYY-MM-DD**.
      - `entryMethod` 'barcodeRead' | 'smartChipRead' | 'swipedOriginUnknown' | 'contactlessChip' | 'ecommerce' | 'manuallyEntered' | 'manuallyEnteredFallback' | 'swiped' | 'swipedFallback' | 'swipedError' | 'scannedCheckReader' | 'credentialOnFile' | 'unknown' — Describes how the merchant received the payment details. If we can't match a dispute to a transaction, we don't return an entryMethod object.
      - `amount` integer — Total amount of the transaction. The value is in the currency's lowest denomination, for example, cents.
      - `link` Link — Object that contains HATEOAS links for the resource.
        - `rel` string, required — Indicates the relationship between the current resource and the target resource.
        - `method` string, required — HTTP method that you need to use with the target resource.
        - `href` string, required — URL of the target resource.

## Other responses

- `400` — Validation error
- `401` — Identity could not be verified
- `403` — Do not have permissions to perform this action
- `406` — Not acceptable
- `500` — An error has occured

---

[API](https://skmtc.dev/payroc/apis/schema.md) · [All operations](https://skmtc.dev/payroc/apis/schema/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/payroc/schema/revisions/1d9d3e305945/schema)
