Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

PaymentCollection - Payment Module Data Models Reference

This documentation provides a reference to the PaymentCollection data model. It belongs to the Payment Module.

idPrimaryKeyModifier<IdProperty>
The ID of the payment collection.
currency_codeTextProperty
The currency code of the payment collection. @example usd
amountBigNumberProperty
The amount of the payment collection
region_idTextProperty
The ID of the payment collection's region.
statusEnumProperty<typeof PaymentCollectionStatus>
The status of the payment collection
payment_providersManyToMany<PaymentProvider>
The associated payment providers.
payment_sessionsHasMany<PaymentSession>
The associated payment sessions.
paymentsHasMany<Payment>
The associated payments.
authorized_amountBigNumberPropertyOptional
The authorized amount of the payment collection
captured_amountBigNumberPropertyOptional
The captured amount of the payment collection
refunded_amountBigNumberPropertyOptional
The refunded amount of the payment collection
completed_atDateTimePropertyOptional
The date the payment collection was completed
metadataJSONPropertyOptional
Holds custom data in key-value pairs.
Was this page helpful?