This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a query to retrieve a list of refunds.
The queryRefunds()
method builds a query to retrieve a list of refunds and returns a RefundsQueryBuilder object.
The returned object contains the query definition which is typically used to run the query using the find()
method.
You can refine the query by chaining RefundsQueryBuilder
methods onto the query. RefundsQueryBuilder
methods enable you to sort, filter, and control the results that queryRefunds.find()
returns.
The query runs with the following RefundsQueryBuilder
defaults that you can override:
The methods that are chained to queryRefunds()
are applied in the order they are called.
The table below shows which RefundsQueryBuilder
methods are supported for queryRefunds()
. You can only use one filter method for each property. Only the first filter will work if a property is used in more than one filter.
PROPERTY | SUPPORTED FILTERS & SORTING |
---|---|
_createdDate | ascending() ,descending() |
chargeId | eq() ,in() |
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.