Search & list Dispute Alerts

get

https://api.staging.payrails.io/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 Params

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[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.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Choose an example:

application/json

200Success.

400Bad Request.

401Unauthorized.

403Insufficient Scope.

404Not Found.

429Too Many Requests.