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

createPaymentCollectionForCartWorkflow - Medusa Core Workflows Reference

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

This workflow creates a payment collection for a cart. It's executed by the Create Payment Collection Store API Route.

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

Source Code

Examples#

Steps#

useRemoteQueryStep

validateCartStep

validateExistingPaymentCollectionStep

createPaymentCollectionsStep

createRemoteLinkStep

Workflow Hook

Step conditioned by when

Input#

CreatePaymentCollectionForCartWorkflowInputDTOCreatePaymentCollectionForCartWorkflowInputDTO
The details to create the payment collection.
cart_idstring
The ID of the cart to create a payment collection for.
metadataRecord<string, unknown>Optional
Custom key-value pairs to store in the payment collection.
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
⇧↵