listCaptures - Payment Module Reference

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

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

Example

To retrieve a list of captures using their IDs:

const captures = await paymentModuleService.listCaptures({
  id: ["capt_123", "capt_321"],
})

To specify relations that should be retrieved within the capture:

const captures = await paymentModuleService.listCaptures(
  {
    id: ["capt_123", "capt_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 captures = await paymentModuleService.listCaptures(
  {
    id: ["capt_123", "capt_321"],
  },
  {
    relations: ["payment"],
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterableCaptureProps

The filters to apply on the retrieved captures.

configFindConfig<CaptureDTO>

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

sharedContextContext

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

Returns

PromisePromise<CaptureDTO[]>Required

The list of captures.