updatePaymentCollectionStep - Medusa Core Workflows Reference

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

This step updates payment collections matching the specified filters.

Example#

Code
1const data = updatePaymentCollectionStep({2  selector: {3    id: "paycol_123",4  },5  update: {6    amount: 10,7  }8})

UpdatePaymentCollectionStepInputUpdatePaymentCollectionStepInput

The data to update a payment collection.

The filters to select the payment collections to update.

The data to update in the selected payment collections.

PaymentCollectionDTO[]PaymentCollectionDTO[]

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.

The total amount to be authorized and captured.

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.