markPaymentCollectionAsPaid - Medusa Core Workflows Reference

This documentation provides a reference to the markPaymentCollectionAsPaid. It belongs to the @medusajs/medusa/core-flows package.

This workflow marks a payment collection for an order as paid. It's used by the Mark Payment Collection as Paid Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around marking a payment collection for an order as paid.

Examples#

Steps#

Input#

Output#

Emitted Events#

This section lists the events that are either triggered by the emitEventStep in the workflow, or by another workflow executed within this workflow.

You can listen to these events in a subscriber, as explained in the Subscribers documentation.

{
  id, // the ID of the payment
}