List disputes

Returns the list of disputes.

To use this endpoint from the browser, you’ll need to specify the /accounts/{your-account-id}/transfers.read scope when generating a token.
GET
/disputes
200 429
List of dispute details.
[
  {
    "amount": {
      "currency": "USD",
      "value": 1204
    },
    "createdOn": "2019-08-24T14:15:22Z",
    "disputeID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
    "merchantAccountID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
    "networkReasonCode": "string",
    "networkReasonDescription": "string",
    "phase": "pre-dispute",
    "respondBy": "2019-08-24T14:15:22Z",
    "status": "response-needed",
    "transfer": {
      "transferID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43"
    }
  }
]
Request was refused due to rate limiting.

X-Retry-In

string <duration>
How long (in milliseconds) to wait until able to retry the request.

Query parameters

count

integer
Optional parameter to limit the number of results in the query.
Default: 200

skip

integer
The number of items to offset before starting to collect the result set.

respondStartDateTime

string <RFC-3339>
Optional date-time which inclusively filters all disputes with respond by after this date-time.

respondEndDateTime

string <RFC-3339>
Optional date-time which exclusively filters all disputes with respond by before this date-time.

status

string
Optional dispute status by which to filter the disputes.
Possible values: response-needed, resolved, under-review, closed, accepted, expired, won, lost

merchantAccountID

string
Optional parameter to filter by merchant account ID.

cardholderAccountID

string
Optional parameter to filter by cardholder account ID.

disputeIDs

string
Optional parameter to filter by a comma separated list of dispute IDs.

transferIDs

string
Optional parameter to filter by a comma separated list of transfer IDs.

startDateTime

string <RFC-3339>
Optional date-time parameter to filter all disputes created on and after the provided date and time.

endDateTime

string <RFC-3339>
Optional date-time parameter to filter all disputes created on and before the provided date and time.

orderBy

string
Optional parameter to order the results in the query.

Response

application/json

amount

object
A representation of money containing an integer value and its currency.
right_key Show child attributes

currency

string <=3 characters Pattern
A 3-letter ISO 4217 currency code.

value

integer<int64>
Quantity in the smallest unit of the specified currency. In USD this is cents, so $12.04 is 1204 and $0.99 would be 99.

createdOn

string<date-time> <=24 characters

disputeID

string<uuid> <=36 characters Pattern
UUID v4

merchantAccountID

string<uuid> <=36 characters Pattern
UUID v4

networkReasonCode

string
Indicates the card network’s category for the dispute. These codes may differ between card brands. You can find more information on the code from the networkReasonDescription field.

networkReasonDescription

string
Provides detail on the card network’s categorization of the dispute.

phase

string<enum>
The phase of a particular dispute.
Possible values: pre-dispute, inquiry, chargeback, unknown

respondBy

string<date-time> <=24 characters

status

string<enum>
The status of a particular dispute. Read our disputes guide to learn what each status means.
Possible values: response-needed, resolved, under-review, closed, accepted, expired, won, lost

transfer

object
Details about the transfer.
right_key Show child attributes

transferID

string<uuid> <=36 characters Pattern
UUID v4