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

PaymentSession - Payment Module Data Models Reference

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

idPrimaryKeyModifier<IdProperty>
The ID of the payment session.
currency_codeTextProperty
The currency code of the payment session. @example usd
amountBigNumberProperty
The authorized amount.
provider_idTextProperty
The ID of the Payment Module Provider used to process the payment.
dataJSONProperty
The data of the payment session that's useful for processing with third-party services. Learn more in this documentation
statusEnumProperty<typeof PaymentSessionStatus>
The status of the payment session
payment_collectionBelongsTo<PaymentCollection>
The associated payment collection.
contextJSONPropertyOptional
The context of the payment session, such as the billing address or the customer's email.
authorized_atDateTimePropertyOptional
The date the payment session was authorized.
paymentHasOne<Payment>Optional
The associated payment.
metadataJSONPropertyOptional
Holds custom data in key-value pairs.
Was this page helpful?