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

Payment - Payment Module Data Models Reference

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

idPrimaryKeyModifier<IdProperty>
The ID of the payment.
amountBigNumberProperty
The amount of the payment
currency_codeTextProperty
The currency code of the payment. @example usd
provider_idTextProperty
The ID of the Payment Module Provider used to process the payment.
payment_collectionBelongsTo<PaymentCollection>
The associated payment collection.
payment_sessionBelongsTo<PaymentSession>
The associated payment session.
refundsHasMany<Refund>
The associated refunds.
capturesHasMany<Capture>
The associated captures.
cart_idTextPropertyOptional
The ID of the cart this payment was created for
order_idTextPropertyOptional
The ID of the order this payment was created for.
customer_idTextPropertyOptional
The ID of the customer making the payment
dataJSONPropertyOptional
The data of the payment that's useful for processing with third-party services. Learn more in this documentation
metadataJSONPropertyOptional
Holds custom data in key-value pairs.
captured_atDateTimePropertyOptional
The date that the payment was captured.
canceled_atDateTimePropertyOptional
The date that the payment was canceled.
Was this page helpful?