fa7c94b4cc
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
114 lines
3.1 KiB
YAML
114 lines
3.1 KiB
YAML
title: Payment Collection
|
|
description: >-
|
|
A payment collection allows grouping and managing a list of payments at one.
|
|
This can be helpful when making additional payment for order edits or
|
|
integrating installment payments.
|
|
type: object
|
|
required:
|
|
- amount
|
|
- authorized_amount
|
|
- created_at
|
|
- created_by
|
|
- currency_code
|
|
- deleted_at
|
|
- description
|
|
- id
|
|
- metadata
|
|
- region_id
|
|
- status
|
|
- type
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
description: The payment collection's ID
|
|
type: string
|
|
example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
|
|
type:
|
|
description: The type of the payment collection
|
|
type: string
|
|
enum:
|
|
- order_edit
|
|
status:
|
|
description: The type of the payment collection
|
|
type: string
|
|
enum:
|
|
- not_paid
|
|
- awaiting
|
|
- authorized
|
|
- partially_authorized
|
|
- canceled
|
|
description:
|
|
description: Description of the payment collection
|
|
nullable: true
|
|
type: string
|
|
amount:
|
|
description: Amount of the payment collection.
|
|
type: integer
|
|
authorized_amount:
|
|
description: Authorized amount of the payment collection.
|
|
nullable: true
|
|
type: integer
|
|
region_id:
|
|
description: The ID of the region this payment collection is associated with.
|
|
type: string
|
|
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
|
|
region:
|
|
description: The details of the region this payment collection is associated with.
|
|
x-expandable: region
|
|
nullable: true
|
|
$ref: ./Region.yaml
|
|
currency_code:
|
|
description: >-
|
|
The 3 character ISO code for the currency this payment collection is
|
|
associated with.
|
|
type: string
|
|
example: usd
|
|
externalDocs:
|
|
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
|
|
description: See a list of codes.
|
|
currency:
|
|
description: The details of the currency this payment collection is associated with.
|
|
x-expandable: currency
|
|
nullable: true
|
|
$ref: ./Currency.yaml
|
|
payment_sessions:
|
|
description: >-
|
|
The details of the payment sessions created as part of the payment
|
|
collection.
|
|
type: array
|
|
x-expandable: payment_sessions
|
|
items:
|
|
$ref: ./PaymentSession.yaml
|
|
payments:
|
|
description: The details of the payments created as part of the payment collection.
|
|
type: array
|
|
x-expandable: payments
|
|
items:
|
|
$ref: ./Payment.yaml
|
|
created_by:
|
|
description: The ID of the user that created the payment collection.
|
|
type: string
|
|
created_at:
|
|
description: The date with timezone at which the resource was created.
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
description: The date with timezone at which the resource was updated.
|
|
type: string
|
|
format: date-time
|
|
deleted_at:
|
|
description: The date with timezone at which the resource was deleted.
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|
|
metadata:
|
|
description: An optional key-value map with additional details
|
|
nullable: true
|
|
type: object
|
|
example:
|
|
car: white
|
|
externalDocs:
|
|
description: Learn about the metadata attribute, and how to delete and update it.
|
|
url: >-
|
|
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|