- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
markPaymentCollectionAsPaid - Medusa Core Workflows Reference
This documentation provides a reference to the markPaymentCollectionAsPaid. It belongs to the @medusajs/medusa/core-flows package.
This workflow marks a payment collection for an order as paid. It's used by the Mark Payment Collection as Paid Admin API Route.
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around marking a payment collection for an order as paid.
Source CodeExamples#
Steps#
Workflow Hook
Step conditioned by when
Input#
MarkPaymentCollectionAsPaidInputMarkPaymentCollectionAsPaidInputThe data to mark a payment collection as paid.
MarkPaymentCollectionAsPaidInputMarkPaymentCollectionAsPaidInputpayment_collection_idstringThe ID of the payment collection to mark as paid.
payment_collection_idstringorder_idstringThe ID of the order that the payment collection belongs to.
order_idstringcaptured_bystringOptionalThe ID of the user marking the payment collection as completed.
captured_bystringOptionalOutput#
PaymentDTOPaymentDTO
PaymentDTOPaymentDTOidstringThe ID of the payment.
idstringamountBigNumberValueThe payment's total amount.
amountBigNumberValuecurrency_codestringThe ISO 3 character currency code of the payment.
currency_codestringprovider_idstringThe ID of the associated payment provider.
provider_idstringpayment_collection_idstringThe ID of the associated payment collection.
payment_collection_idstringThe raw amount of the payment.
The authorized amount of the payment.
The raw authorized amount of the payment.
dataRecord<string, unknown>OptionalThe data relevant for the payment provider to process the payment.
dataRecord<string, unknown>Optionalcreated_atstring | DateOptionalWhen the payment was created.
created_atstring | DateOptionalupdated_atstring | DateOptionalWhen the payment was updated.
updated_atstring | DateOptionalcaptured_atstring | DateOptionalWhen the payment was captured.
captured_atstring | DateOptionalcanceled_atstring | DateOptionalWhen the payment was canceled.
canceled_atstring | DateOptionalThe sum of the associated captures' amounts.
The sum of the associated captures' raw amounts.
The sum of the associated refunds' amounts.
The sum of the associated refunds' raw amounts.
The associated captures.
The associated refunds.
The associated payment collection.
The payment session from which the payment is created.
Was this page helpful?