Skip to main content

Disputes

The Dispute resource represents a card dispute that has been raised by an end customer. More details on card disputes can be found in Unit's disputes guide

Get by Id#

Get a dispute resource by id.

VerbGET
Urlhttps://api.s.unit.sh/disputes/{id}
Required Scopedisputes

Response#

Response is a JSON:API document.

200 OK#

FieldTypeDescription
dataDisputeA dispute resource.
curl -X GET 'https://api.s.unit.sh/disputes/42' \-H "Authorization: Bearer ${TOKEN}"

List#

List dispute resources. Paging can be applied.

VerbGET
Urlhttps://api.s.unit.sh/disputes
Required Scopedisputes

Query Parameters#

NameTypeDefaultDescription
page[limit]integer100Optional. Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]integer0Optional. Number of resources to skip. See Pagination.
filter[query]string(empty)Optional. Search term according to the Full-Text Search Rules.

Response#

Response is a JSON:API document.

200 OK#

FieldTypeDescription
dataArray of DisputesArray of dispute resources.
curl -X GET 'https://api.s.unit.sh/disputes?page[limit]=20&page[offset]=10' \-H "Authorization: Bearer ${TOKEN}"