listAndCountPaymentCollections - Payment Module Reference
This documentation provides a reference to the listAndCountPaymentCollections
method. This belongs to the Payment Module.
This method retrieves a paginated list of payment collections along with the total count of available payment collections satisfying the provided filters.
Example
To retrieve a list of {type name} using their IDs:
To specify relations that should be retrieved within the {type name}:
By default, only the first {default limit}
records are retrieved. You can control pagination by specifying the skip
and take
properties of the config
parameter:
Parameters
The filters to apply on the retrieved payment collection.
config
FindConfig<PaymentCollectionDTO>The configurations determining how the payment collection is retrieved. Its properties, such as select
or relations
, accept the
attributes or relations associated with a payment collection.
config
FindConfig<PaymentCollectionDTO>select
or relations
, accept the
attributes or relations associated with a payment collection.Returns
The list of payment collections along with their total count.
Was this section helpful?