PApayroc
Settlement

List disputes

Changed on

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.
get/disputes

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/disputes
  • Auth
    HTTP bearer

Query parameters

beforestring

Return the previous page of results before the value that you specify.

You can’t send the before parameter in the same request as the after parameter.

afterstring

Return the next page of results after the value that you specify.

You can’t send the after parameter in the same request as the before parameter.

limitinteger

Limit the maximum number of results that we return for each page.

datestring date required

Filter results by the date that the dispute was submitted.

merchantIdstring

Filter results by the unique identifier that the processor assigned to the merchant.

Response

Successful request. Returns a paginated list of disputes.

limitinteger

Maximum number of results that we return for each page.

countinteger

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

hasMoreboolean

Indicates whether there is another page of results available.

Changes

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API

  • 9af893904873Revision changes
    • info

      api operation id listDisputes removed and replaced with settlement_listDisputes