listPayments - Payment Module Reference

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

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

Example

To retrieve a list of payments using their IDs:

const payments = await paymentModuleService.listPayments({
  id: ["pay_123", "pay_321"],
})

To specify relations that should be retrieved within the payment:

const payments = await paymentModuleService.listPayments(
  {
    id: ["pay_123", "pay_321"],
  },
  {
    relations: ["payment_session"],
  }
)

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 payments = await paymentModuleService.listPayments(
  {
    id: ["pay_123", "pay_321"],
  },
  {
    relations: ["payment_session"],
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterablePaymentProps

The filters to apply on the retrieved payment.

configFindConfig<PaymentDTO>

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

sharedContextContext

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

Returns

PromisePromise<PaymentDTO[]>Required

A list of payment.