completePaymentCollections - Payment Module Reference

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

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.

Example

const paymentCollection =
  await paymentModuleService.completePaymentCollections(
    "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<PaymentCollectionDTO>Required

The payment collection's details.

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

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

Example

const paymentCollection =
  await paymentModuleService.completePaymentCollections([
    "pay_col_123",
    "pay_col_321",
  ])

Parameters

paymentCollectionIdstring[]Required

The payment collections' IDs.

sharedContextContext

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

Returns

PromisePromise<PaymentCollectionDTO[]>Required

The payment collections' details.