createOrUpdateOrderPaymentCollectionWorkflow - Medusa Core Workflows Reference

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

This workflow creates or updates payment collection for an order. It's used by other order-related workflows, such as createOrderPaymentCollectionWorkflow to update an order's payment collections based on changes made to the order.

You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating or updating payment collections for an order.

Source Code

Examples#

Steps#

Input#

order_idstring
amountnumberOptional

Output#

PaymentCollectionDTO[]PaymentCollectionDTO[]
PaymentCollectionDTOPaymentCollectionDTO
The payment collection details.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break