listPaymentProviders - Payment Module Reference

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

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

Example

To retrieve a list of payment providers using their IDs:

const paymentProviders =
  await paymentModuleService.listPaymentProviders({
    id: ["stripe", "system"],
  })

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 paymentProviders =
  await paymentModuleService.listPaymentProviders(
    {
      id: ["stripe", "system"],
    },
    {
      take: 20,
      skip: 2,
    }
  )

Parameters

filtersFilterablePaymentProviderProps

The filters to apply on the retrieved payment providers.

configFindConfig<PaymentProviderDTO>

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

sharedContextContext

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

Returns

PromisePromise<PaymentProviderDTO[]>Required

The list of payment providers.