listPayments - Payment Module Reference

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

Example#

To retrieve a list of payments using their IDs:

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

To specify relations that should be retrieved within the payment:

Code
1const payments = await paymentModuleService.listPayments(2  {3    id: ["pay_123", "pay_321"],4  },5  {6    relations: ["payment_session"],7  }8)

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

Parameters#

filtersFilterablePaymentPropsOptional

The filters to apply on the retrieved payment.

configFindConfig<PaymentDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<PaymentDTO[]>

A list of payment.

Was this page helpful?