validateCartPaymentsStep - Medusa Core Workflows Reference

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

This step validates a cart's payment sessions. Their status must be pending or requires_more. If not valid, the step throws an error.

Tip: You can use the retrieveCartStep to retrieve a cart's details.

Example#

Code
1const data = validateCartPaymentsStep({2  // retrieve the details of the cart from another workflow3  // or in another step using the Cart Module's service4  cart5})

Input#

ValidateCartPaymentsStepInputValidateCartPaymentsStepInput

The cart's details.

cartCartWorkflowDTO

The cart to validate payment sessions for.

Output#

PaymentSessionDTO[]PaymentSessionDTO[]

idstring

The ID of the payment session.

amountBigNumberValue

The amount to authorize.

currency_codestring

The 3 character currency code of the payment session.

provider_idstring

The ID of the associated payment provider.

dataRecord<string, unknown>

The data necessary for the payment provider to process the payment session.

statusPaymentSessionStatus

The status of the payment session.

created_atstring | Date

When the payment session was created

updated_atstring | Date

When the payment session was updated

payment_collection_idstring

The ID of the associated payment collection.

contextRecord<string, unknown>Optional

The context necessary for the payment provider.

authorized_atDateOptional

When the payment session was authorized.

payment_collectionPaymentCollectionDTOOptional

The payment collection the session is associated with.

paymentPaymentDTOOptional

The payment created from the session.