listPaymentSessions - Payment Module Reference

This documentation provides a reference to the listPaymentSessions 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 sessions based on optional filters and configuration.

Example#

To retrieve a list of payment sessions using their IDs:

Code
1const paymentSessions =2  await paymentModuleService.listPaymentSessions({3    id: ["payses_123", "payses_321"],4  })

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

Code
1const paymentSessions =2  await paymentModuleService.listPaymentSessions(3    {4      id: ["payses_123", "payses_321"],5    },6    {7      relations: ["payment"],8    }9  )

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

Code
1const paymentSessions =2  await paymentModuleService.listPaymentSessions(3    {4      id: ["payses_123", "payses_321"],5    },6    {7      relations: ["payment"],8      take: 20,9      skip: 2,10    }11  )

Parameters#

filtersFilterablePaymentSessionPropsOptional

The filters to apply on the retrieved payment sessions.

configFindConfig<PaymentSessionDTO>Optional

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.

sharedContextContextOptional

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

Returns#

PromisePromise<PaymentSessionDTO[]>

The list of payment sessions.

Was this page helpful?