---
title: "Search & list Dispute Alerts"
method: GET
path: "/dispute/disputes/alerts"
tags: ["Disputes"]
---

# Search & list Dispute Alerts

`GET /dispute/disputes/alerts`

Search and list pre-chargeback dispute alerts in your workspace. Use the available filters to narrow results by status, match state, program, and date range.

## Query parameters

- `filter[id]` string
- `filter[workspaceId]` string
- `filter[enrollmentId]` string
- `filter[status]` string
- `filter[displayStatus]` string
- `filter[matchState]` string
- `filter[subProvider]` string
- `filter[paymentId]` string
- `filter[disputeId]` string
- `filter[arn]` string
- `filter[createdAt]` string
- `filter[providerCreatedAt]` string

## Response `200`

Success.

- object
  - `links` object
    - `self` string, required
    - `prev` string
    - `next` string
    - `first` string
    - `last` string
  - `results` object[]
    - `id` string, uuid, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `workspaceId` string, uuid, nullable — The workspace of the matched payment; absent until the alert is matched.
    - `enrollmentId` string, uuid, required — ID of the enrollment that produced this alert.
    - `externalReference` string, required — The provider's identifier for this alert.
    - `providerCreatedAt` string, date-time, nullable — When the provider created the alert.
    - `program` 'Ethoca' | 'CDRN' | 'RDR' | 'SAFE' | 'TC40' | 'Discover' | 'AMEX' | 'JCB' | 'Unknown', required — The network program that issued the alert. `Unknown` is a forward-compatible sentinel for a program Payrails does not yet have a canonical value for.
    - `alertType` string, nullable — Provider-specific alert type. Open-ended (not a fixed enum); Chargeblast documents `FRAUD` and `DISPUTE` as known values but does not guarantee an exhaustive list.
    - `amount` object, required
      - `value` string, required — Decimal amount of the major currency unit. Can be any precision.
      - `currency` string, required — ISO 3-letter currency code.
    - `cardBIN` string, nullable
    - `cardLast4` string, nullable
    - `network` string, nullable — The card network, normalized to the canonical Payrails value (`commondto.CardNetwork` — e.g. `visa`, `mastercard`, `amex`, `discover`, `jcb`), matching the payment instrument's `network`. Null when the provider's brand could not be classified.
    - `descriptor` string, nullable — The merchant descriptor carried on the alert.
    - `arn` string, nullable — Acquirer Reference Number used to match the alert to a payment.
    - `authCode` string, nullable
    - `transactionDate` string, date-time, nullable
    - `expiresAt` string, date-time, nullable — When the alert's action window closes, derived from the provider's near-expiry notification. Null until that notification is received.
    - `paymentId` string, uuid, nullable — The matched Payrails payment, when the alert resolved to a single payment.
    - `matchState` 'matched' | 'unmatched' | 'ambiguous' | 'retrying', required — How the alert maps to a Payrails payment.
    - `status` 'Received' | 'Resolved' | 'Declined' | 'WillExpire' | 'Expired' | 'ActionFailed', required — Lifecycle state of the alert.
    - `reason` string, nullable
    - `outcome` 'Resolved' | 'AlreadyRefunded' | 'AlreadyChargeback' | 'Ineligible' | 'MIDLost' | 'NotMyDescriptor' | 'EscalateChargeback' | 'TDS' | 'UnmatchedCannotFindTransaction', nullable — The specific outcome the merchant selected when actioning the alert (the `result` from the action request). Persisted alongside the binary `status`. Null until the alert is successfully actioned.
    - `displayStatus` 'Processing' | 'ActionNeeded' | 'Ignored' | 'Refunded' | 'Expired' | 'Unrecognized' — Merchant-facing status bucket, derived from status, matchState and outcome (computed server-side, not stored). Also accepted as a multi-select filter via filter[displayStatus].
    - `actionedVia` string, nullable — How the alert was actioned (e.g. portal).
    - `actionedByUserId` string, uuid, nullable — The user who actioned the alert, when actioned by a portal user.
    - `actionedAt` string, date-time, nullable
    - `lastError` string, nullable
    - `ruleset` string, nullable
    - `disputeId` string, uuid, nullable — The dispute this alert is linked to, when a chargeback followed.

## Other responses

- `400` — Bad Request.
- `401` — Unauthorized.
- `403` — Insufficient Scope.
- `404` — Not Found.
- `429` — Too Many Requests.

---

[API](https://skmtc.net/payrails/apis/payrails-api-reference.md) · [All operations](https://skmtc.net/payrails/apis/payrails-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payrails/payrails-api-reference/versions/9dd2f0158582/schema)