v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB

Disputes

Search & list Dispute 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.

get/dispute/disputes/alerts

Query parameters

filter[id]string

Filter for a list of alerts by ID.

filter[workspaceId]string

Filter for a list of alerts by workspace ID.

filter[enrollmentId]string

Filter for a list of alerts by enrollment ID.

filter[status]string

Filter for a list of alerts by status (e.g. Received, Resolved, Declined).

filter[displayStatus]string

Filter for a list of alerts by one or more merchant-facing status buckets, comma-separated (e.g. filter[displayStatus]=Processing,ActionNeeded).

filter[matchState]string

Filter for a list of alerts by match state (matched, unmatched, ambiguous, retrying).

filter[subProvider]string

Filter for a list of alerts by network program (Ethoca, CDRN, RDR, SAFE).

filter[paymentId]string

Filter for a list of alerts by matched payment ID.

filter[disputeId]string

Filter for a list of alerts by linked dispute ID.

filter[arn]string

Filter for a list of alerts by Acquirer Reference Number.

filter[createdAt]string

Filter for a list of alerts by creation date. Accepts ISO 8601 date-time values or range expressions (e.g. [2024-01-01T00:00:00Z,2024-12-31T23:59:59Z)).

filter[providerCreatedAt]string

Filter for a list of alerts by provider creation date. Accepts ISO 8601 date-time values or range expressions.

Response

Success.

Example response

{
  "results": [
    {
      "amount": {
        "value": "12.50",
        "currency": "EUR"
      }
    }
  ]
}