Skip to main content
Skip to main content

listRefunds - Payment Module Reference

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

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

Example

To retrieve a list of refunds using their IDs:

const refunds = await paymentModuleService.listRefunds({
id: ["ref_123", "ref_321"],
})

To specify relations that should be retrieved within the refund:

const refunds = await paymentModuleService.listRefunds(
{
id: ["ref_123", "ref_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 refunds = await paymentModuleService.listRefunds(
{
id: ["ref_123", "ref_321"],
},
{
relations: ["payment"],
take: 20,
skip: 2,
}
)

Parameters

The filters to apply on the retrieved refunds.
The configurations determining how the refund is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a refund.
sharedContextContext
A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<RefundDTO[]>Required
The list of refunds.
Was this section helpful?