List disputes

Returns the list of disputes.

Read our disputes guide to learn more.

To access this endpoint using an access token you’ll need to specify the /accounts/{accountID}/transfers.read scope.

GET
/accounts/{accountID}/disputes
cURL Go
1
2
curl -X GET "https://api.moov.io/accounts/{accountID}/disputes" \
  -H "Authorization: Bearer {token}" \
1
2
3
4
5
mc, _ := moov.NewClient()

var accountID string

mc.ListDisputes(ctx, accountID)
200 400 401 403 409 429 500 504
The request completed successfully.
[
  {
    "amount": {
      "currency": "USD",
      "value": 257753
    },
    "createdOn": "2024-12-23T17:55:00Z",
    "disputeID": "6e356108-fdfa-4910-bbe4-1e3c8abf5520",
    "merchantAccountID": "34233b72-780c-4e0e-8b08-cbbe1bc878f8",
    "networkReasonCode": "10.4",
    "phase": "chargeback",
    "respondBy": "2024-12-23T18:55:00Z",
    "status": "response-needed",
    "transfer": {
      "transferID": "ecac148a-917e-4ee0-b46a-c51408939fff"
    }
  }
]

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The server could not understand the request due to invalid syntax.
{
  "error": "string"
}

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The user is not authorized to make the request.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request conflicted with the current state of the target resource.
{
  "error": "string"
}

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

x-moov-version

string
API version

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Default: v2024.01.00

Path parameters

accountID

string <uuid> required

Query parameters

skip

integer <int64>

count

integer <int64>
Default: 200

startDateTime

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

endDateTime

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

respondStartDateTime

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

respondEndDateTime

string <date-time>
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 <uuid>
Optional parameter to filter by merchant account ID.

cardholderAccountID

string <uuid>
Optional parameter to filter by cardholder account ID.

disputeIDs

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

transferIDs

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

orderBy

string

Response

application/json

amount

object
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

value

integer<int64> required

Quantity in the smallest unit of the specified currency.

In USD this is cents, for example, $12.04 is 1204 and $0.99 is 99.

createdOn

string<date-time>

disputeID

string<uuid>

merchantAccountID

string<uuid>

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 dispute within the dispute lifecycle.
Possible values: pre-dispute, inquiry, chargeback, unknown

respondBy

string<date-time>

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
Show child attributes

transferID

string<uuid> required
The disputed transfer’s ID.