listCaptures - Payment Module Reference

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

Example#

To retrieve a list of captures using their IDs:

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

To specify relations that should be retrieved within the capture:

Code
1const captures = await paymentModuleService.listCaptures(2  {3    id: ["capt_123", "capt_321"],4  },5  {6    relations: ["payment"],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 captures = await paymentModuleService.listCaptures(2  {3    id: ["capt_123", "capt_321"],4  },5  {6    relations: ["payment"],7    take: 20,8    skip: 2,9  }10)

Parameters#

filtersFilterableCapturePropsOptional

The filters to apply on the retrieved captures.

configFindConfig<CaptureDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<CaptureDTO[]>

The list of captures.

Was this page helpful?