throwUnlessStatusIsNotPaid - Medusa Core Workflows Reference

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

This step validates that the order doesn't have an active payment collection.

src/workflows/my-workflow.ts
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { throwUnlessStatusIsNotPaid } from "@medusajs/medusa/core-flows"3
4const myWorkflow = createWorkflow(5  "my-workflow",6  () => {7    const data = throwUnlessStatusIsNotPaid({8      "paymentCollection": {9        "id": "id_azcYQBRz6KRyzen",10        "currency_code": "mnt",11        "amount": {12          "numeric": 1513        },14        "status": "completed",15        "payment_providers": [{16          "id": "id_Q46GidwN6Y",17          "is_enabled": false18        }]19      }20    })21  }22)

Input#

paymentCollectionPaymentCollectionDTO

The payment collection details.

idstring

The ID of the payment collection.

currency_codestring

The ISO 3 character currency code of the payment sessions and payments associated with payment collection.

amountBigNumberValue

The total amount to be authorized and captured.

statusPaymentCollectionStatus

The status of the payment collection.

payment_providersPaymentProviderDTO[]

The payment provider used to process the associated payment sessions and payments.

authorized_amountBigNumberValueOptional

The amount authorized within the associated payment sessions.

refunded_amountBigNumberValueOptional

The amount refunded within the associated payments.

captured_amountBigNumberValueOptional

The amount captured within the associated payments.

completed_atstring | DateOptional

When the payment collection was completed.

created_atstring | DateOptional

When the payment collection was created.

updated_atstring | DateOptional

When the payment collection was updated.

metadataRecord<string, unknown>Optional

Holds custom data in key-value pairs.

payment_sessionsPaymentSessionDTO[]Optional

The associated payment sessions.

paymentsPaymentDTO[]Optional

The associated payments.

Was this page helpful?