Skip to main content
GET
List disputes

Authorizations

Authorization
string
header
required

Bearer credential for the public API: a live COPE API key (ck_live_*; keys issued earlier as cope_sk_live_* keep working). Dashboard sign-in tokens are not accepted.

Query Parameters

processor_id
string

The processor's dispute id (Stripe du_... or dp_..., PayPal PP-D-...); returns that dispute, so its id can be read. One value, matched exactly; an unknown or another business's id returns an empty page. Without it every dispute is returned.

state
string

Which dispute states to return: one of open, won, lost, or several separated by commas (open,won). Without it every state is returned. An unknown name or an empty element is refused with 422.

page
integer

Page number for paginated results. Values below 1 and non-numeric values are ignored and the first page is returned; a page past the last one returns the last page. current_page is accepted as an older name for it and wins when both are sent.

Required range: x >= 1
per_page
integer

Number of records per page. Defaults to 12; values above 25 are clamped to 25; values below 1 and non-numeric values are ignored and the default is used. items and limit are accepted as older names for it, read only when per_page is absent.

Required range: 1 <= x <= 25

Response

Successful response

data
object[]
required
pagination
object
required