# Retrieve disputes

Retrieves a list of all disputes.

Endpoint: GET /disputes
Version: latest
Security: SecretApiKey, JWT

## Security:

  - `SecretApiKey` (unknown)
    apiKey in header REB-APIKEY

  - `JWT` (unknown)
    http bearer JWT

## Query parameters:

  - `filter` (string)
    Criteria for filtering collection items.
This field requires a special format.
Use `,` to specify multiple allowed values.
Use `;` to specify multiple fields.

For more information, see [Search filters](https://www.rebilly.com/docs/dev-docs/search-filters).

  - `sort` (array)
    Sorts and orders the collection of items. To sort in descending
order, prefix with `-`. Multiple fields can be sorted by separating each with `,`.

  - `limit` (integer)
    Limit the number of collection items to be returned.
Use `0` to return an empty collection and still receive the count of matching items in `Pagination-Total`.

  - `offset` (integer)
    Specifies the starting point within the collection of items to be returned.

  - `q` (string)
    Use this field to perform a partial search of text fields.

  - `expand` (string)
    Expands a request to include embedded objects within the `_embedded`
property of the response. This field accepts a comma-separated list of objects.

For more information, see
[Embedded resources](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).

## Response 200:

  - `200` (unknown)
    List of disputes successfully retrieved.

## Response 200 fields (application/json):

  - `id` (string)
    ID of the dispute.
    Example: dp_0YVCE8J5F2DE58FV0S8YASW4HK

  - `customerId` (string | null)
    ID of the customer who is disputing a transaction.
    Example: cus_0YV7DDSDD1C8DA64KHH2W33CPF

  - `transactionId` (string | null)
    ID of the disputed transaction.
    Example: txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0

  - `currency` (string)
    Currency code in ISO 4217 format.
    Example: USD

  - `amount` (number)
    Dispute amount.

  - `acquirerReferenceNumber` (string | null)
    Acquirer reference number for the dispute.

  - `caseId` (string | null)
    Case ID of the dispute.

  - `reasonCode` (string | null)
    Code used in the chargeback that describes the reason for the dispute.

  - `reasonDescription` (string | null)
    Description of the reason for the dispute.

  - `category` (string)
    Category of dispute.
    Enum: "fraud", "authorization", "processing-errors", "consumer-disputes", "uncategorized", "bank-return"

  - `type` (string)
    Type of dispute.
    Enum: "information-request", "first-chargeback", "second-chargeback", "arbitration", "fraud", "ethoca-alert", "verifi-alert", "bank-return", "paypal-claim", "representment", "inquiry", "forced-refund", "collaboration"

  - `status` (string)
    Status of the dispute.
    Enum: "response-needed", "under-review", "forfeited", "won", "lost", "unknown"

  - `postedTime` (string)
    Date and time when the dispute is posted.

  - `deadlineTime` (string | null)
    Latest date and time by when a merchant must submit a representment for a dispute.
If the deadline is missed, the merchant loses the dispute.

  - `rawResponse` (string | null)
    Raw response from the payment gateway that processed the disputed transaction.

  - `resolvedTime` (string | null)
    Date and time when the dispute is resolved.

  - `source` (string | null)
    Source of the dispute.
    Enum: null, "api", "manual", "sftp", "webhook"

  - `revision` (integer)
    Number of times the dispute data has been modified.

Use the revision number when analyzing webhook data to
determine if a change should take precedence over the current
representation.

  - `createdTime` (string)
    Date and time when the resource is created.
This value is set automatically when the resource is created.

  - `updatedTime` (string)
    Date and time when the resource is updated.
This value is set automatically when the resource is updated.

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "self", "transaction", "customer", "attachments"

  - `_embedded` (object)
    Embedded objects that are requested by the `expand` query parameter.

  - `_embedded.transaction` (object)

  - `_embedded.customer` (object)

## Response 200 headers (application/json):

  - `Pagination-Total` (integer)
    Total number of items that match the request.
The value is independent of `limit`, including when `limit` is `0`.
    Example: 332

  - `Pagination-Limit` (integer)
    Maximum number of items per page.
    Example: 100

  - `Pagination-Offset` (integer)
    Specifies the starting point within the
collection of resource results. For example, a request with
`limit=20` retrieves and displays the first 20 results on a page. A
following request with `limit=20` and `offset=20`, retrieves the next
page of 20 results.
    Example: 2

## Response 401:

  - `401` (unknown)
    Unauthorized access.
Invalid credentials used.

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403:

  - `403` (unknown)
    Access forbidden.
If the organization requires multi-factor authentication (MFA) and the session has not passed MFA, `error` is `mfa_required`.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `error` (string)
    Message that describes why the request is forbidden.
Most responses use a descriptive message, such as `Not allowed to change security settings`.
If the organization requires multi-factor authentication (MFA) and MFA verification has not been completed for the session, this value is `mfa_required`.
If the request sets `requireMfa` to `true` and MFA verification has not been completed for the session, this value is `mfa_required_for_caller`.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.