> 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

# QueryRefunds

# Package: payments

# Namespace: RefundService

# Method link: https://dev.wix.com/docs/api-reference/business-management/payments/refunds/query-refunds.md

## Permission Scopes:
Read Refunds: SCOPE.DC-PAYMENTS.READ-REFUNDS

## Introduction

Retrieves a list of refunds given the provided paging, filtering, and sorting. Up to 100 Refunds can be returned per request.

To learn how to query refunds, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).

---

## REST API

### Schema

```
 Method: queryRefunds
 Description: Retrieves a list of refunds given the provided paging, filtering, and sorting. Up to 100 Refunds can be returned per request.  To learn how to query refunds, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
 URL: https://www.wixapis.com/payments/refunds/v1/refunds/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: Number of items to load. 
        - name: cursor | type: string | description: Pointer to the next or previous page in the list of results.  You can get 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: QueryRefundsResponse
  - name: refunds | type: array<Refund> | description: List of refunds. 
     - name: id | type: string | description: Refund GUID. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the refund is updated.  Ignored when creating a refund. 
     - name: createdDate | type: string | description: Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#coordinated_Universal_Time_(UTC)) format. For example, "2024-01-30T13:30:00". 
     - name: updatedDate | type: string | description: Date and time the refund was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#coordinated_Universal_Time_(UTC)) format. For example, "2024-01-30T13:30:00". 
     - name: extendedFields | type: ExtendedFields | description: Custom field data for the refund object.  [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.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: chargeId | type: string | description: GUID of the charge to refund. 
     - name: currencyCode | type: string | description: Refund currency. Should be the same as the charge currency. 
     - name: amount | type: string | description: Amount being returned to the buyer in the refund currency's main units (such as dollars or euros). For example, `"12.95"`. 
     - name: returnedApplicationFee | type: string | description: Application fee returned to the merchant from Wix in the refund currency's main units (such as dollars or euros). For example, `"12.95"`.  Only included if an application fee was returned. 
     - name: returnedProcessingFee | type: string | description: Processing fee returned to the merchant from the payment service provider in the refund currency's main units (such as dollars or euros). For example, `"12.95"`.  This field is empty when the processing fee is unknown. 
     - name: full | type: boolean | description: Whether the refund is for the entire amount of the charge. 
     - name: status | type: Status | description: Status of the refund.  Learn more about the [refund lifecycle](https://dev.wix.com/docs/rest/business-management/payments/refunds/introduction.md#lifecycle-of-a-refund>). 
         - enum:
         -     PENDING: Refund is in progress.
         -     SUCCEEDED: Refund succeeded.
         -     FAILED: Refund failed.
         -     REVERSED: Refund had succeeded, but has since been reversed.
     - name: providerRefundId | type: string | description: Payment service provider's GUID for the refund. 
     - name: reason | type: string | description: Reason this refund was issued. 
     - name: statusInfo | type: StatusInfo | description: Details about the refund status. Used to provide additional information about why a refund was given its status. 
        - name: code | type: string | description: Reason code with detailed information about the refund status. See the full list of [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes.md#refund-declined). 
        - name: description | type: string | description: Description of the status. 
     - name: acquirerReferenceNumber | type: string | description: Unique number assigned to a refund. This number is shared across all parties involved in processing the refund. It allows the merchant to track the refund with their bank. 
     - name: note | type: string | description: Note providing additional information about this refund. 
  - name: pagingMetadata | type: CursorPagingMetadata | description: Metadata for the paginated results. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Offset that was requested. 
        - name: next | type: string | description: Cursor pointing to next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to previous page in the list of results. 
     - name: hasNext | type: boolean | description: Indicates if there are more results after the current page. If `true`, another page of results can be retrieved. If `false`, this is the last page. 


```

### Examples

### Query refunds
Get last 10 refunds for a charge that are not failed or reversed

```curl
curl -X POST \
  'https://www.wixapis.com/payments/refunds/v1/refunds/query' \
  -H 'Authorization: <AUTH>' \
  -H 'Content-Type: application/json'
  --data-binary '{
    "query": {
      "filter": {
        "chargeId": "602b516f-e8a2-4e1a-9a17-0708099a74db",
        "$not": {
          "status": {"$in": ["FAILED", "REVERSED"]}
        }
      },
      "sort": [{"fieldName": "createdDate", "order": "DESC"}],
      "cursorPaging": {
        "limit": 10
      }
    }
  }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.payments.RefundService.queryRefunds(query)
 Description: Retrieves a list of refunds given the provided paging, filtering, and sorting. Up to 100 Refunds can be returned per request.  To learn how to query refunds, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
 # 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: RefundQuery   | 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: Number of items to load. 
        - name: cursor | type: string | description: Pointer to the next or previous page in the list of results.  You can get 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<QueryRefundsResponse>
  - name: refunds | type: array<Refund> | description: List of refunds. 
     - name: _id | type: string | description: Refund GUID. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the refund is updated.  Ignored when creating a refund. 
     - name: _createdDate | type: Date | description: Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#coordinated_Universal_Time_(UTC)) format. For example, "2024-01-30T13:30:00". 
     - name: _updatedDate | type: Date | description: Date and time the refund was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#coordinated_Universal_Time_(UTC)) format. For example, "2024-01-30T13:30:00". 
     - name: extendedFields | type: ExtendedFields | description: Custom field data for the refund object.  [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.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: chargeId | type: string | description: GUID of the charge to refund. 
     - name: currencyCode | type: string | description: Refund currency. Should be the same as the charge currency. 
     - name: amount | type: string | description: Amount being returned to the buyer in the refund currency's main units (such as dollars or euros). For example, `"12.95"`. 
     - name: returnedApplicationFee | type: string | description: Application fee returned to the merchant from Wix in the refund currency's main units (such as dollars or euros). For example, `"12.95"`.  Only included if an application fee was returned. 
     - name: returnedProcessingFee | type: string | description: Processing fee returned to the merchant from the payment service provider in the refund currency's main units (such as dollars or euros). For example, `"12.95"`.  This field is empty when the processing fee is unknown. 
     - name: full | type: boolean | description: Whether the refund is for the entire amount of the charge. 
     - name: status | type: Status | description: Status of the refund.  Learn more about the [refund lifecycle](https://dev.wix.com/docs/rest/business-management/payments/refunds/introduction.md#lifecycle-of-a-refund>). 
         - enum:
         -     PENDING: Refund is in progress.
         -     SUCCEEDED: Refund succeeded.
         -     FAILED: Refund failed.
         -     REVERSED: Refund had succeeded, but has since been reversed.
     - name: providerRefundId | type: string | description: Payment service provider's GUID for the refund. 
     - name: reason | type: string | description: Reason this refund was issued. 
     - name: statusInfo | type: StatusInfo | description: Details about the refund status. Used to provide additional information about why a refund was given its status. 
        - name: code | type: string | description: Reason code with detailed information about the refund status. See the full list of [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes.md#refund-declined). 
        - name: description | type: string | description: Description of the status. 
     - name: acquirerReferenceNumber | type: string | description: Unique number assigned to a refund. This number is shared across all parties involved in processing the refund. It allows the merchant to track the refund with their bank. 
     - name: note | type: string | description: Note providing additional information about this refund. 
  - name: pagingMetadata | type: CursorPagingMetadata | description: Metadata for the paginated results. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Offset that was requested. 
        - name: next | type: string | description: Cursor pointing to next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to previous page in the list of results. 
     - name: hasNext | type: boolean | description: Indicates if there are more results after the current page. If `true`, another page of results can be retrieved. If `false`, this is the last page. 


```

### Examples

### queryRefunds
```javascript
import { refunds } from '@wix/payments';

async function queryRefunds(query) {
  const response = await refunds.queryRefunds(query);
};
```

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

async function myQueryRefundsMethod(query) {
  const elevatedQueryRefunds = auth.elevate(refunds.queryRefunds);
  const response = await elevatedQueryRefunds(query);
}
```

### queryRefunds (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 { refunds } from '@wix/payments';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

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


async function queryRefunds(query) {
  const response = await myWixClient.refunds.queryRefunds(query);
};
```

---