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

createPaymentCollectionsStep - Medusa Core Workflows Reference

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

This step creates payment collections in a cart.

Example#

Code
1const data = createPaymentCollectionsStep([{2  "currency_code": "usd",3  "amount": 404}])

Input#

CreatePaymentCollectionCartStepInputCreatePaymentCollectionCartStepInput
The details of the payment collections to create.
currency_codestring
amountBigNumberInput
The payment collection's amount.
metadataRecord<string, unknown>Optional
Custom key-value pairs to store in 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
⇧↵