Search & list Disputes

get

https://api.staging.payrails.io/dispute/disputes

Fetch a list of Disputes.

Query Params

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[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[assignedToUserEmail]

string

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

filter[defensePeriodExpiresAt]

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[merchantReference]

string

Filter for a list of disputes by merchant reference.

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.

includeSummary

boolean

Defaults to false

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

includePayment

boolean

Defaults to false

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

includeInstrument

boolean

Defaults to false

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

includeRepresentmentPlanStatus

boolean

Defaults to false

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

includeUserEmail

boolean

Defaults to false

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

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Choose an example:

application/json

200Success.

400Bad Request.

401Unauthorized.

403Insufficient Scope.

404Not Found.

429Too Many Requests.