listPaymentSessions - Payment Module Reference

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

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

Example

To retrieve a list of payment sessions using their IDs:

const paymentSessions =
  await paymentModuleService.listPaymentSessions({
    id: ["payses_123", "payses_321"],
  })

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

const paymentSessions =
  await paymentModuleService.listPaymentSessions(
    {
      id: ["payses_123", "payses_321"],
    },
    {
      relations: ["payment"],
    }
  )

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 paymentSessions =
  await paymentModuleService.listPaymentSessions(
    {
      id: ["payses_123", "payses_321"],
    },
    {
      relations: ["payment"],
      take: 20,
      skip: 2,
    }
  )

Parameters

filtersFilterablePaymentSessionProps

The filters to apply on the retrieved payment sessions.

configFindConfig<PaymentSessionDTO>

The configurations determining how the payment session is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a payment session.

sharedContextContext

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

Returns

PromisePromise<PaymentSessionDTO[]>Required

The list of payment sessions.