restorePaymentCollections - Payment Module Reference

This documentation provides a reference to the restorePaymentCollections 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 restores soft deleted payment collection by their IDs.

Example#

Code
await paymentModule.restorePaymentCollections(["paycol_123"])

Parameters#

idstring[]

The IDs of payment collections.

configRestoreReturn<TReturnableLinkableKeys>Optional

Configurations determining which relations to restore along with each of the payment collection. You can pass to its returnLinkableKeys property any of the payment collection's relation attribute names.

sharedContextContextOptional

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

Returns#

PromisePromise<void | Record<TReturnableLinkableKeys, string[]>>

An object that includes the IDs of related records that were restored. If there are no related records restored, the promise resolves to void.

Was this page helpful?