Skip to main content
Skip to main content

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:

const paymentCollections =
await paymentModuleService.listAndCountPaymentCollections({
id: ["pay_col_123", "pay_col_321"],
})

To specify relations that should be retrieved within the {type name}:

const paymentCollections =
await paymentModuleService.listAndCountPaymentCollections(
{
id: ["pay_col_123", "pay_col_321"],
},
{
relations: ["payment_sessions"],
}
)

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:

const paymentCollections =
await paymentModuleService.listAndCountPaymentCollections(
{
id: ["pay_col_123", "pay_col_321"],
},
{
relations: ["payment_sessions"],
take: 20,
skip: 2,
}
)

Parameters

The filters to apply on the retrieved payment collection.
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.
sharedContextContext
A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<[PaymentCollectionDTO[], number]>Required
The list of payment collections along with their total count.
Was this section helpful?