createPaymentCollectionsStep - Medusa Core Workflows Reference
This documentation provides a reference to the createPaymentCollectionsStep. It belongs to the @medusajs/medusa/core-flows package.
This step creates payment collections in a cart.
Example#
Input#
CreatePaymentCollectionCartStepInputCreatePaymentCollectionCartStepInputThe details of the payment collections to create.
CreatePaymentCollectionCartStepInputCreatePaymentCollectionCartStepInputcurrency_codestring
currency_codestringamountBigNumberInputThe payment collection's amount.
amountBigNumberInputmetadataRecord<string, unknown>OptionalCustom key-value pairs to store in the payment collection.
metadataRecord<string, unknown>OptionalOutput#
PaymentCollectionDTO[]PaymentCollectionDTO[]
PaymentCollectionDTO[]PaymentCollectionDTO[]idstringThe ID of the payment collection.
idstringcurrency_codestringThe ISO 3 character currency code of the payment sessions and payments associated with payment collection.
currency_codestringamountBigNumberValueThe total amount to be authorized and captured.
amountBigNumberValuestatusPaymentCollectionStatusThe status of the payment collection.
statusPaymentCollectionStatusThe payment provider used to process the associated payment sessions and payments.
The amount authorized within the associated payment sessions.
The amount refunded within the associated payments.
The amount captured within the associated payments.
completed_atstring | DateOptionalWhen the payment collection was completed.
completed_atstring | DateOptionalcreated_atstring | DateOptionalWhen the payment collection was created.
created_atstring | DateOptionalupdated_atstring | DateOptionalWhen the payment collection was updated.
updated_atstring | DateOptionalmetadataRecord<string, unknown>OptionalHolds custom data in key-value pairs.
metadataRecord<string, unknown>OptionalThe associated payment sessions.
The associated payments.
Was this page helpful?