> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# QueryDisputeHistoryRecords

# Package: disputes

# Namespace: DisputeHistoryRecordService

# Method link: https://dev.wix.com/docs/api-reference/business-management/payments/disputes/dispute-history-records/query-dispute-history-records.md

## Permission Scopes:
Read Disputes: SCOPE.DC-PAYMENTS.READ-DISPUTES

## Introduction

Retrieves a list of dispute history records, given the provided paging, filtering, and sorting.


Query Dispute History Records runs with these defaults, which you can override:

- `createdDate` is sorted in `DESC` order
- `paging.limit` is `50`
- `paging.offset` is `0`

To learn how to query disputes, see
[About the Wix API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md).

---

## REST API

### Schema

```
 Method: queryDisputeHistoryRecords
 Description: Retrieves a list of dispute history records, given the provided paging, filtering, and sorting.   Query Dispute History Records runs with these defaults, which you can override:  - `createdDate` is sorted in `DESC` order - `paging.limit` is `50` - `paging.offset` is `0`  To learn how to query disputes, see [About the Wix API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md).
 URL: https://www.wixapis.com/payments/dispute-history-records/v1/dispute-history-records/query
 Method: POST
 Method parameters:
   param name: query | type: CursorQuery   
     - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. 
        - name: limit | type: integer | description: Maximum number of items to return in the results. 
        - name: cursor | type: string | description: Pointer to the next or previous page in the list of results.  Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. 
        - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` 
        - name: sort | type: array<Sorting> | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` 
           - name: fieldName | type: string | description: Name of the field to sort by. 
           - name: order | type: SortOrder | description: Sort order. 
                 - enum: ASC, DESC
 Return type: QueryDisputeHistoryRecordsResponse
  - name: disputeHistoryRecords | type: array<DisputeHistoryRecord> | description: Retrieved dispute history records. 
     - name: id | type: string | description: Dispute history record GUID. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the dispute history record is updated. To prevent conflicting changes, the existing revision must be specified when updating a dispute history record. 
     - name: createdDate | type: string | description: Date and time the dispute history record was created. 
     - name: updatedDate | type: string | description: Date and time the dispute history record was last updated. 
     - name: disputeId | type: string | description: GUID of the dispute that this history record is a snapshot of. 
     - name: stage | type: DisputeStage | description: Stage of the dispute process. 
         - enum:
         -     CHARGEBACK: Formal dispute filed through the card network or issuing bank.
         -     INQUIRY: Initial inquiry from the customer requesting information about the charge.
     - name: status | type: DisputeStatus | description: Status of the dispute at the time this record was created. Indicates what action was required and by whom at this point in the dispute lifecycle. 
         - enum:
         -     WAITING_MERCHANT: Waiting for merchant action, such as submitting evidence or accepting the dispute.
         -     UNDER_REVIEW: Dispute is under review by the payment service provider (internal channel) or bank (external channel).
         -     WAITING_BUYER: Waiting for buyer action or response.
         -     WON: Dispute was resolved in favor of the merchant.
         -     LOST: Dispute was resolved in favor of the cardholder.
     - name: dueDate | type: string | description: The latest date and time until which the dispute can remain in its current status.  If this date passes, the dispute will be resolved against the party that is required to take action. For example, if the status is `WAITING_MERCHANT`, and the due date passes, the dispute will be `LOST` and a refund will be processed automatically. 
     - name: chargeId | type: string | description: GUID of the charge that is being disputed. 
     - name: channel | type: DisputeChannel | description: Channel through which the dispute is being processed. 
         - enum:
         -     INTERNAL: Dispute is processed by the payment service provider.
         -     EXTERNAL: Dispute is processed through the card network or issuing bank.
     - name: extendedFields | type: ExtendedFields | description: Custom field data for the dispute history record object.  [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. 
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 
     - name: tags | type: Tags | description: Tags assigned to the dispute history record for organization and filtering purposes. 
        - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. 
           - name: tagIds | type: array | description: List of tag GUIDs. 
        - name: publicTags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. 
  - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata for cursor-based pagination. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. 
        - name: next | type: string | description: Cursor string pointing to the next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. 
     - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page.  + `true`: Another page of results can be retrieved. + `false`: This is the last page. 


```

### Examples

### Query dispute history records
Query dispute history records with filtering, sorting, and paging

```curl
curl -X POST \
'https://www.wixapis.com/payments/dispute-history-records/v1/dispute-history-records/query' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
-d '{
  "query": {
    "filter": {
      "disputeId": "87654321-4321-4321-4321-210987654321"
    },
    "sort": [
      {
        "fieldName": "createdDate",
        "order": "ASC"
      }
    ],
    "paging": {
      "limit": 50
    }
  }
}'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.disputes.DisputeHistoryRecordService.queryDisputeHistoryRecords(query)
 Description: Retrieves a list of dispute history records, given the provided paging, filtering, and sorting.   Query Dispute History Records runs with these defaults, which you can override:  - `createdDate` is sorted in `DESC` order - `paging.limit` is `50` - `paging.offset` is `0`  To learn how to query disputes, see [About the Wix API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md).
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  query
 Method parameters: 
   param name: query | type: DisputeHistoryRecordQuery   | required: true
     - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. 
        - name: limit | type: integer | description: Maximum number of items to return in the results. 
        - name: cursor | type: string | description: Pointer to the next or previous page in the list of results.  Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. 
        - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` 
        - name: sort | type: array<Sorting> | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` 
           - name: fieldName | type: string | description: Name of the field to sort by. 
           - name: order | type: SortOrder | description: Sort order. 
                 - enum: ASC, DESC
 Return type: PROMISE<QueryDisputeHistoryRecordsResponse>
  - name: disputeHistoryRecords | type: array<DisputeHistoryRecord> | description: Retrieved dispute history records. 
     - name: _id | type: string | description: Dispute history record GUID. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the dispute history record is updated. To prevent conflicting changes, the existing revision must be specified when updating a dispute history record. 
     - name: _createdDate | type: Date | description: Date and time the dispute history record was created. 
     - name: _updatedDate | type: Date | description: Date and time the dispute history record was last updated. 
     - name: disputeId | type: string | description: GUID of the dispute that this history record is a snapshot of. 
     - name: stage | type: DisputeStage | description: Stage of the dispute process. 
         - enum:
         -     CHARGEBACK: Formal dispute filed through the card network or issuing bank.
         -     INQUIRY: Initial inquiry from the customer requesting information about the charge.
     - name: status | type: DisputeStatus | description: Status of the dispute at the time this record was created. Indicates what action was required and by whom at this point in the dispute lifecycle. 
         - enum:
         -     WAITING_MERCHANT: Waiting for merchant action, such as submitting evidence or accepting the dispute.
         -     UNDER_REVIEW: Dispute is under review by the payment service provider (internal channel) or bank (external channel).
         -     WAITING_BUYER: Waiting for buyer action or response.
         -     WON: Dispute was resolved in favor of the merchant.
         -     LOST: Dispute was resolved in favor of the cardholder.
     - name: dueDate | type: Date | description: The latest date and time until which the dispute can remain in its current status.  If this date passes, the dispute will be resolved against the party that is required to take action. For example, if the status is `WAITING_MERCHANT`, and the due date passes, the dispute will be `LOST` and a refund will be processed automatically. 
     - name: chargeId | type: string | description: GUID of the charge that is being disputed. 
     - name: channel | type: DisputeChannel | description: Channel through which the dispute is being processed. 
         - enum:
         -     INTERNAL: Dispute is processed by the payment service provider.
         -     EXTERNAL: Dispute is processed through the card network or issuing bank.
     - name: extendedFields | type: ExtendedFields | description: Custom field data for the dispute history record object.  [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. 
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 
     - name: tags | type: Tags | description: Tags assigned to the dispute history record for organization and filtering purposes. 
        - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. 
           - name: tagIds | type: array | description: List of tag GUIDs. 
        - name: publicTags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. 
  - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata for cursor-based pagination. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. 
        - name: next | type: string | description: Cursor string pointing to the next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. 
     - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page.  + `true`: Another page of results can be retrieved. + `false`: This is the last page. 


```

### Examples

### queryDisputeHistoryRecords
```javascript
import { disputeHistoryRecords } from '@wix/payments';

async function queryDisputeHistoryRecords(query) {
  const response = await disputeHistoryRecords.queryDisputeHistoryRecords(query);
};
```

### queryDisputeHistoryRecords (with elevated permissions)
```javascript
import { disputeHistoryRecords } from '@wix/payments';
import { auth } from '@wix/essentials';

async function myQueryDisputeHistoryRecordsMethod(query) {
  const elevatedQueryDisputeHistoryRecords = auth.elevate(disputeHistoryRecords.queryDisputeHistoryRecords);
  const response = await elevatedQueryDisputeHistoryRecords(query);
}
```

### queryDisputeHistoryRecords (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { disputeHistoryRecords } from '@wix/payments';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { disputeHistoryRecords },
  // Include the auth strategy and host as relevant
});


async function queryDisputeHistoryRecords(query) {
  const response = await myWixClient.disputeHistoryRecords.queryDisputeHistoryRecords(query);
};
```

---