API referenceDisputes

Disputes against your charges

Every dispute raised against this business, newest first. Each row carries the disputed charge's amount and reference, so a list does not need a call per row to say what is at stake. `open_count` is computed over all of this business's disputes rather than the page: the page is filtered and paged, and a count taken from it would say "3 open" when it meant "3 open on this screen".

GET
/api/b/v1/disputes

Every dispute raised against this business, newest first.

Each row carries the disputed charge's amount and reference, so a list does not need a call per row to say what is at stake.

open_count is computed over all of this business's disputes rather than the page: the page is filtered and paged, and a count taken from it would say "3 open" when it meant "3 open on this screen".

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Query Parameters

status?|

Defaults to every dispute; narrow to one status to work a queue.

charge_id?|null
limit?Limit
Range1 <= value <= 200
Default50
offset?Offset
Range0 <= value
Default0
admin_access_token?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/disputes"
{  "disputes": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "charge_id": "cf8b747b-a752-4d0a-9a4d-7d19fc1769f3",      "reason": "unauthorized",      "description": "string",      "status": "open",      "evidence": {},      "resolution_notes": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "resolved_at": "2019-08-24T14:15:22Z",      "amount_minor": 0,      "currency": "string",      "charge_reference": "string"    }  ],  "open_count": 0}