listPaymentCollections - Payment Module Reference

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

This method retrieves a paginated list of payment collections based on optional filters and configuration.

Example

To retrieve a list of payment collections using their IDs:

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

To specify relations that should be retrieved within the payment collection:

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

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

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

Parameters

filtersFilterablePaymentCollectionProps

The filters to apply on the retrieved payment collection.

configFindConfig<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.

sharedContextContext

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

Returns

PromisePromise<PaymentCollectionDTO[]>Required

The list of payment collections.