listAndCountPaymentCollections - Payment Module Reference

This documentation provides a reference to the listAndCountPaymentCollections method. This belongs to the Payment Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

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:

Code
1const paymentCollections =2  await paymentModuleService.listAndCountPaymentCollections({3    id: ["pay_col_123", "pay_col_321"],4  })

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

Code
1const paymentCollections =2  await paymentModuleService.listAndCountPaymentCollections(3    {4      id: ["pay_col_123", "pay_col_321"],5    },6    {7      relations: ["payment_sessions"],8    }9  )

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:

Code
1const paymentCollections =2  await paymentModuleService.listAndCountPaymentCollections(3    {4      id: ["pay_col_123", "pay_col_321"],5    },6    {7      relations: ["payment_sessions"],8      take: 20,9      skip: 2,10    }11  )

Parameters#

filtersFilterablePaymentCollectionPropsOptional

The filters to apply on the retrieved payment collection.

configFindConfig<PaymentCollectionDTO>Optional

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.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<[PaymentCollectionDTO[], number]>

The list of payment collections along with their total count.

Was this page helpful?