• 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

PaymentCollectionDTO

The payment collection 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 collection.
      currency_codestring
      The ISO 3 character currency code of the payment sessions and payments associated with payment collection.
      region_idstring
      The id of the associated region.
      amountBigNumberValue
      The total amount to be authorized and captured.
      statusPaymentCollectionStatus
      The status of the payment collection.
      payment_providersPaymentProviderDTO[]
      The payment provider used to process the associated payment sessions and payments.
      authorized_amountBigNumberValueOptional
      The amount authorized within the associated payment sessions.
      refunded_amountBigNumberValueOptional
      The amount refunded within the associated payments.
      captured_amountBigNumberValueOptional
      The amount captured within the associated payments.
      completed_atstring | DateOptional
      When the payment collection was completed.
      created_atstring | DateOptional
      When the payment collection was created.
      updated_atstring | DateOptional
      When the payment collection was updated.
      metadataRecord<string, unknown>Optional
      Holds custom data in key-value pairs.
      payment_sessionsPaymentSessionDTO[]Optional
      The associated payment sessions.
      paymentsPaymentDTO[]Optional
      The associated payments.