SchemaReportingSettlement

List disputes

Use this method to return a paginated list of disputes.

Use query parameters to filter the list of results that we return, for example, to search for disputes linked to a specific merchant.

Important: You must provide a value for the date query parameter.

Our gateway returns the following information about each dispute in the list:

  • Its status, type, and description.
  • Transaction that the dispute is linked to, including the transaction date, merchant who ran the transaction, and the payment method that the cardholder used.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

beforestringOptional
Points to the resource identifier that you want to receive your results before. Typically, this is the first resource on the previous page.
afterstringOptional
Points to the resource identifier that you want to receive your results after. Typically, this is the last resource on the previous page.
limitintegerOptional<=100Defaults to 10
States the total amount of results the response is limited to.
datedateRequired
Filter results by the date that the dispute was submitted.
merchantIdstringOptional
Filter results by the unique identifier that the processor assigned to the merchant.

Response

Successful request. Returns a paginated list of disputes.
datalist of objects
Array of dispute objects.
countdouble or null
Number of results that we returned.
hasMoreboolean or null
Indicates that further results are available.
limitdouble or null
Maximum number of results that we return for each page.

Errors