Menu

StorePaymentCollection

The payment collection details.

Properties#

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.
amountnumber
The total amount to be authorized and captured.
statusBasePaymentCollectionStatus
The status of the payment collection.
payment_providersStorePaymentProvider[]
The providers used for the payment collection's sessions.
authorized_amountnumberOptional
The amount authorized within the associated payment sessions.
captured_amountnumberOptional
The amount captured within the associated payment sessions.
refunded_amountnumberOptional
The amount refunded 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.
paymentsBasePayment[]Optional
The associated payments.
payment_sessionsStorePaymentSession[]Optional
The payment collection's sessions.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵