Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Dispute Management Endpoints

dispute-management/list

This endpoint allows you to fetch a list of your disputes and chargebacks.

get/dispute-management/list

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

DisputeStatusstring

Filters results by status: UnderReview, WitMerchant, or Closed. Default is null (i.e., all disputes are returned).

DisputeStagestring

Filters results by stage. Default is null (i.e., all disputes are returned).

DisputeIDstring

Filters results by dispute ID

Currencystring

Filters results by currency. Default is null (i.e., all disputes are returned).

CardBrandstring

Filters results by card brand: visa, mastercard, amex, discover. Default is null (i.e., all disputes are returned).

FromDatestring

Filters results that occurred on or after this date/time. Must be specified in YYYY-MM-DD format. Default is 30 days ago.

ToDatestring

Filters results that occurred on or before this date/time. Must be specified in either YYYY-MM-DD format. Default is the current date/time.

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

Example response

{
  "Disputes": {
    "0": {
      "DisputeID": "1",
      "DisputeCreatedOn": "2019-01-01T00:00:00",
      "DisputeStatus": "UnderReview",
      "DisputeStage": "First Chargeback",
      "DisputeCurrency": "USD",
      "DisputeReason": "Damaged goods",
      "DisputeReasonCode": "1",
      "DisputeResult": "Won",
      "DisputeReplyByDate": "2019-01-01T00:00:00",
      "DisputeCardBrand": "Visa",
      "DisputeCardLast4": "1234",
      "DisputeARN": "123456789"
    }
  }
}