Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

createOrderPaymentCollectionWorkflow - Medusa Core Workflows Reference

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

This workflow creates a payment collection for an order. It's used by the Create Payment Collection Admin API Route.

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

Source Code

Examples#

Steps#

useRemoteQueryStep

createPaymentCollectionsStep

createRemoteLinkStep

Workflow Hook

Step conditioned by when

Input#

CreateOrderPaymentCollectionWorkflowInputCreateOrderPaymentCollectionWorkflowInput
The details of the payment collection to create.
order_idstring
The id of the order for which to create a payment collection.
amountnumber
The amount of the payment collection.

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
⇧↵