Skip to main content
GET
Search & list Disputes

Authorizations

Authorization
string
header
required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Query Parameters

filter[id]
string

Filter for a list of disputes by ID.

filter[providerId]
string

Filter for a list of disputes by provider ID.

filter[providerConfigId]
string

Filter for a list of disputes by provider config ID.

filter[providerReference]
string

Filter for a list of disputes by provider reference.

filter[paymentId]
string

Filter for a list of disputes by payment ID.

filter[paymentProviderReference]
string

Filter for a list of disputes by payment provider reference.

filter[holderReference]
string

Filter for a list of disputes by holder reference.

filter[customerEmail]
string

Filter for a list of disputes by customer email.

filter[stage]
string

Filter for a list of disputes by stage.

filter[defenseStatus]
string

Filter for a list of disputes by defense status.

filter[chargebackStatus]
string

Filter for a list of disputes by chargeback status.

filter[channel]
string

Filter for a list of disputes by the channel the customer used to raise them.

filter[assignedToUserEmail]
string

Filter for a list of disputes by assigned to user email.

filter[defensePeriodExpiresAt]
string<date-time>

Filter for a list of disputes by defense period expiration date.

filter[reason]
string

Filter for a list of disputes by reason.

filter[reasonCode]
string

Filter for a list of disputes by reason code.

filter[providerCreatedAt]
string

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

filter[merchantReference]
string

Filter for a list of disputes by merchant reference.

filter[executionId]
string

Filter for a list of disputes by execution ID.

filter[containsall][tags]
string

Filter disputes by attached tag slugs. Accepts a comma-separated list of tag slugs (e.g. fraud,bin_list). Only disputes that have all of the specified tags attached are returned.

sort[defensePeriodExpiresAt]
enum<string>

Order the list by defense deadline. asc returns the soonest-expiring disputes first, desc the furthest out; disputes with no deadline are returned last either way.

Exactly one sort[field] parameter may be given per request: a second one, a repeated one, a bare sort=field, or a direction other than asc or desc all return 400.

The last link resolves in either direction, and the page it returns is the one holding the disputes with no deadline.

Available options:
asc,
desc
sort[providerCreatedAt]
enum<string>

Order the list by the date the provider raised the dispute. This is the default ordering, descending, when no sort[field] parameter is given. Disputes with no such date are returned last either way.

The one-term limit and the last link behaviour apply here too, as described on sort[defensePeriodExpiresAt].

Available options:
asc,
desc
includeSummary
boolean
default:false

Boolean indicating if the disputes summary should be included in the response.

includePayment
boolean
default:false

Boolean indicating if the disputes payment should be included in the response.

includeInstrument
boolean
default:false

Boolean indicating if the disputes instrument should be included in the response.

includeRepresentmentPlanStatus
boolean
default:false

Boolean indicating if the representment plan status should be included in the response.

includeUserEmail
boolean
default:false

Boolean indicating if the assigned user email and username should be included in the response.

Response

Success.

results
object[]
summary
object | null
Last modified on October 1, 2026