type: object
description: The payment collection's details.
x-schemaName: AdminPaymentCollection
required:
  - payment_providers
  - id
  - currency_code
  - amount
  - status
properties:
  id:
    type: string
    title: id
    description: The payment collection's ID.
  currency_code:
    type: string
    title: currency_code
    description: The payment collection's currency code.
  amount:
    type: number
    title: amount
    description: The total amount to be paid.
  authorized_amount:
    type: number
    title: authorized_amount
    description: The total authorized amount of the collection's payments.
  captured_amount:
    type: number
    title: captured_amount
    description: The total captured amount of the collection's payments.
  refunded_amount:
    type: number
    title: refunded_amount
    description: The total refunded amount of the collection's payments.
  completed_at:
    type: string
    format: date-time
    title: completed_at
    description: The date the payment collection was completed.
  created_at:
    type: string
    format: date-time
    title: created_at
    description: The date the payment collection was created.
  updated_at:
    type: string
    format: date-time
    title: updated_at
    description: The date the payment collection was updated.
  metadata:
    type: object
    description: The payment collection's metadata, can hold custom key-value pairs.
    externalDocs:
      url: https://docs.medusajs.com/api/admin#manage-metadata
      description: Learn how to manage metadata
  status:
    type: string
    description: The payment collection's status.
    enum:
      - canceled
      - not_paid
      - awaiting
      - authorized
      - partially_authorized
  payment_providers:
    type: array
    description: >-
      The payment provider used to process the collection's payments and
      sessions.
    items:
      $ref: ./AdminPaymentProvider.yaml
  payment_sessions:
    type: array
    description: The payment collection's payment sessions.
    items:
      $ref: ./AdminPaymentSession.yaml
  payments:
    type: array
    description: The payment collection's payments.
    items:
      $ref: ./AdminPayment.yaml