completePaymentCollections - Payment Module Reference

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

completePaymentCollections(paymentCollectionId, sharedContext?): Promise<PaymentCollectionDTO>#

This method marks a payment collection as completed by settings its completed_at field to the current date and time.

Code
1const paymentCollection =2  await paymentModuleService.completePaymentCollections(3    "pay_col_123"4  )

paymentCollectionIdstring

The payment collection's ID.

sharedContextContextOptional

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

The payment collection's details.

This method marks payment collections as completed by settings their completed_at field to the current date and time.

Code
1const paymentCollection =2  await paymentModuleService.completePaymentCollections([3    "pay_col_123",4    "pay_col_321",5  ])

paymentCollectionIdstring[]

The payment collections' IDs.

sharedContextContextOptional

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

The payment collections' details.

Was this page helpful?