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

updatePaymentCollectionStep - Medusa Core Workflows Reference

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

This step updates payment collections matching the specified filters.

Example#

Code
1const data = updatePaymentCollectionStep({2  selector: {3    id: "paycol_123",4  },5  update: {6    amount: 10,7  }8})

Input#

UpdatePaymentCollectionStepInputUpdatePaymentCollectionStepInput
The data to update a payment collection.
selectorFilterablePaymentCollectionProps
The filters to select the payment collections to update.
updatePaymentCollectionUpdatableFields
The data to update in the selected payment collections.

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