throwUnlessPaymentCollectionNotPaid - Medusa Core Workflows Reference

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

This step validates that the payment collection is not paid. If not valid, the step will throw an error.

Note: You can retrieve a payment collection's details using Query, or useQueryGraphStep.

Example#

Code
1const data = throwUnlessPaymentCollectionNotPaid({2  paymentCollection: {3    id: "paycol_123",4    // other payment details...5  }6})

ThrowUnlessPaymentCollectionNotePaidInputThrowUnlessPaymentCollectionNotePaidInput

The details of the payment collection to validate.

The payment collection to validate.