914d773d3a
* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
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
|