v1

latestOpenAPI 3.1.02026-07-24260142.2 KB

/merchant-disputes/search

Sandbox (Testing): https://gateway.sand.us.zip.co/merchant-disputes/search<br><br>Search merchant disputes.

get/merchant-disputes/search

Query parameters

merchantIdstring

The merchant's Id.

startDatestring date

Return disputes after the given date. Example Format: YYYY-MM-DD

endDatestring date

Return disputes before the given date. Example Format: YYYY-MM-DD

statusstring

If set, filter disputes by their status. e.g. WarningNeedsResponse, WarningUnderReview, WarningClosed, NeedsResponse, UnderReview, ChargeRefunded, Won, Lost.

dateColumnFilterstring

Date Filter - default is dispute date. DisputeDate RespondByDate SettledDate

pageSizeinteger

The number of results per page.

pagestring

The page number.

orderBystring

An ordering specification.

Headers

QP-Territorystring required

Territory of the request. Available values : US.

Response

200

totalinteger

Example response

{
  "value": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customerFirstName": "string",
      "customerLastName": "string",
      "paymentPlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "orderNumber": "string",
      "disputeId": "string",
      "status": "string",
      "reason": "string",
      "disputedOn": "2023-09-06T15:29:54.412Z",
      "evidenceDueOn": "2023-09-06T15:29:54.412Z",
      "settledOn": "2023-09-06T15:29:54.412Z",
      "currencyCode": "string"
    }
  ]
}