deletePaymentCollections - Payment Module Reference

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

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

This method deletes a payment collection by its ID.

Example

await paymentModuleService.deletePaymentCollections([
  "pay_col_123",
  "pay_col_321",
])

Parameters

paymentCollectionIdstring[]Required

The payment collection's ID.

sharedContextContext

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

Returns

PromisePromise<void>Required

Resolves when the payment collection is deleted successfully.

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

This method deletes a payment collection by its ID.

Example

await paymentModuleService.deletePaymentCollections(
  "pay_col_123"
)

Parameters

paymentCollectionIdstringRequired

The payment collection's ID.

sharedContextContext

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

Returns

PromisePromise<void>Required

Resolves when the payment collection is deleted successfully.