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 CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
order_idstringamountnumberOptionalOutput#
PaymentCollectionDTO[]PaymentCollectionDTO[]
PaymentCollectionDTO[]PaymentCollectionDTO[]idstringThe ID of the payment collection.
idstringcurrency_codestringThe ISO 3 character currency code of the payment sessions and payments associated with payment collection.
currency_codestringamountBigNumberValueThe total amount to be authorized and captured.
amountBigNumberValuestatusPaymentCollectionStatusThe status of the payment collection.
statusPaymentCollectionStatusThe payment provider used to process the associated payment sessions and payments.
The amount authorized within the associated payment sessions.
The amount refunded within the associated payments.
The amount captured within the associated payments.
completed_atstring | DateOptionalWhen the payment collection was completed.
completed_atstring | DateOptionalcreated_atstring | DateOptionalWhen the payment collection was created.
created_atstring | DateOptionalupdated_atstring | DateOptionalWhen the payment collection was updated.
updated_atstring | DateOptionalmetadataRecord<string, unknown>OptionalHolds custom data in key-value pairs.
metadataRecord<string, unknown>OptionalThe associated payment sessions.
The associated payments.
Was this page helpful?