listRefunds - Payment Module Reference
This documentation provides a reference to the listRefunds
method. This belongs to the Payment Module.
This method retrieves a paginated list of refunds based on optional filters and configuration.
Example
To retrieve a list of refunds using their IDs:
To specify relations that should be retrieved within the refund:
By default, only the first 15
records are retrieved. You can control pagination by specifying the skip
and take
properties of the config
parameter:
Parameters
filters
FilterableRefundPropsThe filters to apply on the retrieved refunds.
filters
FilterableRefundPropsconfig
FindConfig<RefundDTO>The configurations determining how the refund is retrieved. Its properties, such as select
or relations
, accept the
attributes or relations associated with a refund.
config
FindConfig<RefundDTO>select
or relations
, accept the
attributes or relations associated with a refund.Returns
The list of refunds.
Was this section helpful?