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.
Source CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
MarkPaymentCollectionAsPaidInputMarkPaymentCollectionAsPaidInputThe data to mark a payment collection as paid.
MarkPaymentCollectionAsPaidInputMarkPaymentCollectionAsPaidInputpayment_collection_idstringThe ID of the payment collection to mark as paid.
payment_collection_idstringorder_idstringThe ID of the order that the payment collection belongs to.
order_idstringcaptured_bystringOptionalThe ID of the user marking the payment collection as completed.
captured_bystringOptionalOutput#
null | PaymentDTOnull | PaymentDTO
null | PaymentDTOnull | PaymentDTOnull | PaymentDTOnull | PaymentDTO
null | PaymentDTOnull | PaymentDTOWas this page helpful?