GET/card_disputes

List card disputes

Lists card disputes, with optional filters for creation time, status, and idempotency key. Use cursor and limit to retrieve pages, and pass comma-separated values for status.in.

8 parameters
cursorstringoptional
Return the page of entries after this cursor.
limitintegeroptional
Maximum number of card disputes to return, from 1 to 100. Defaults to 100 when omitted.
Default:100
created_at.afterstringoptional
Return disputes created after this ISO 8601 timestamp.
created_at.beforestringoptional
Return disputes created before this ISO 8601 timestamp.
created_at.on_or_afterstringoptional
Return disputes created on or after this ISO 8601 timestamp.
created_at.on_or_beforestringoptional
Return disputes created on or before this ISO 8601 timestamp.
status.inarray<string>optional
Filter by one or more dispute statuses: user_submission_required, pending_user_submission_reviewing, pending_user_submission_submitting, pending_user_withdrawal_submitting, pending_response, lost, won, or rejected. Encode multiple values as a comma-separated string.
idempotency_keystringoptional
Filter to the dispute with this idempotency key. Must contain 1 to 200 characters.

3 status codes
200Returns a page containing an array of card dispute objects and a `next_cursor` for retrieving the next page.
dataarray<CardDispute>required
The contents of the list.
next_cursorstringrequired
A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.
4XXReturned when the request results in a client error.
5XXReturned when the request results in a server error.

Error handling

limit must be between 1 and 100, and idempotency_key must contain 1 to 200 characters. status.in accepts the documented card dispute statuses, and each created_at filter must be an ISO 8601 timestamp.