• Overview
  • Examples
  • Recipes
  • Commerce Modules
  • Architectural Modules
  • Integrations
  • Storefront Development
    • SDKs and Tools
    • create-medusa-app
    • Medusa CLI
    • JS SDK
    • Next.js Starter Storefront
    General
    • Medusa Configurations
    • Deployment Guides
    • Troubleshooting Guides
    Admin
    • Admin Widget Injection Zones
    • Admin Components
    Lists
    • Container Dependencies
    • Events List
    References
    • Workflows SDK
    • Data Model Language
    • Service Factory
    • Helper Steps
    • Core Workflows
    • Testing Framework
    Other
    • Contribution Guidelines
      • Docs
      • Admin Translations
    • Usage
  • Get Started
  • Product
    Commerce Modules
    Architectural Modules
  • Resources
    Guides
    Examples
    Recipes
    Admin Components
    Storefront Development
    UI Library
  • Tools & SDKs
    Medusa CLI
    JS SDK
    Next.js Starter
    create-medusa-app
    Integrations
  • Framework
    Modules
    API Routes
    Workflows
    Data Models
    Subscribers
    Scheduled Jobs
    Loaders
    Admin Customizations
    Links
    Query
  • Reference
    Admin API
    Store API
    Core Workflows
    Data Model Language
    Service Factory
    Events Reference
    Admin Widget Injection Zones
v2.2·Report Issue
Homepage
Medusa v1
Changelog
Troubleshooting
Hide Sidebar⌘\
Theme
Light
Dark
Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

PaymentDTO

Loading...
Was this page helpful?
Edit this page
      Guides
      • All Areas
      • Guides
      • References
      • Admin API (v2)
      • Store API (v2)
      • Medusa UI
      Navigation↑↓
      Open Result↵
      idstring
      The ID of the payment.
      amountBigNumberValue
      The payment's total amount.
      currency_codestring
      The ISO 3 character currency code of the payment.
      provider_idstring
      The ID of the associated payment provider.
      payment_collection_idstring
      The ID of the associated payment collection.
      raw_amountBigNumberValueOptional
      The raw amount of the payment.
      authorized_amountBigNumberValueOptional
      The authorized amount of the payment.
      raw_authorized_amountBigNumberValueOptional
      The raw authorized amount of the payment.
      cart_idstringOptional
      The ID of the associated cart.
      order_idstringOptional
      The ID of the associated order.
      order_edit_idstringOptional
      The ID of the associated order edit.
      customer_idstringOptional
      The ID of the associated customer.
      dataRecord<string, unknown>Optional
      The data relevant for the payment provider to process the payment.
      created_atstring | DateOptional
      When the payment was created.
      updated_atstring | DateOptional
      When the payment was updated.
      captured_atstring | DateOptional
      When the payment was captured.
      canceled_atstring | DateOptional
      When the payment was canceled.
      captured_amountBigNumberValueOptional
      The sum of the associated captures' amounts.
      raw_captured_amountBigNumberValueOptional
      The sum of the associated captures' raw amounts.
      refunded_amountBigNumberValueOptional
      The sum of the associated refunds' amounts.
      raw_refunded_amountBigNumberValueOptional
      The sum of the associated refunds' raw amounts.
      capturesCaptureDTO[]Optional
      The associated captures.
      refundsRefundDTO[]Optional
      The associated refunds.
      payment_collectionPaymentCollectionDTOOptional
      The associated payment collection.
      payment_sessionPaymentSessionDTOOptional
      The payment session from which the payment is created.