capturePaymentWorkflow - Medusa Core Workflows Reference

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

This workflow captures a payment. It's used by the Capture Payment Admin API Route.

You can use this workflow within your own customizations or custom workflows, allowing you to capture a payment in your custom flows.

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
}