deletePaymentCollections - Payment Module Reference

This documentation provides a reference to the deletePaymentCollections 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.

deletePaymentCollections(paymentCollectionId, sharedContext?): Promise<void>#

This method deletes a payment collection by its ID.

Code
1await paymentModuleService.deletePaymentCollections([2  "pay_col_123",3  "pay_col_321",4])

paymentCollectionIdstring[]

The payment collection's ID.

sharedContextContextOptional

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

PromisePromise<void>

Resolves when the payment collection is deleted successfully.