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.
Source CodeWorkflow hook
Step conditioned by when
View step details
CapturePaymentWorkflowInput
CapturePaymentWorkflowInputpayment_id
stringcaptured_by
stringOptionalPaymentDTO
PaymentDTOid
stringamount
BigNumberValuecurrency_code
stringprovider_id
stringpayment_collection_id
stringdata
Record<string, unknown>Optionalcreated_at
string | DateOptionalupdated_at
string | DateOptionalcaptured_at
string | DateOptionalcanceled_at
string | DateOptionalThis 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.
Event | Description | Payload | Action |
---|---|---|---|
| Emitted when a payment is captured. |
|