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

PaymentSessionDTO

The payment session details.

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 session.
      amountBigNumberValue
      The amount to authorize.
      currency_codestring
      The 3 character currency code of the payment session.
      provider_idstring
      The ID of the associated payment provider.
      dataRecord<string, unknown>
      The data necessary for the payment provider to process the payment session.
      statusPaymentSessionStatus
      The status of the payment session.
      payment_collection_idstring
      The ID of the associated payment collection.
      contextRecord<string, unknown>Optional
      The context necessary for the payment provider.
      authorized_atDateOptional
      When the payment session was authorized.
      payment_collectionPaymentCollectionDTOOptional
      The payment collection the session is associated with.
      paymentPaymentDTOOptional
      The payment created from the session.