docs: generate references manually for v2.1.2 (#10639)
* docs: manually generate references for v2.1.2 * more changes
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
ee62083c52
commit
0f5d640736
196 files changed
+267336
-200539
No files matched your search
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: paymentModelReference
|
||||
slug: /references/payment/models/Capture
|
||||
sidebar_label: Capture
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Capture - Payment Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the Capture . This belongs to the Payment Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment","type":"[Payment](../payment_models.Payment/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"captured_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"refunds","type":"Collection<[Refund](../payment_models.Refund/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../payment_models.Payment/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_reason_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"refund_reason","type":"`null` \\| [RefundReason](../payment_models.RefundReason/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"note","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandLine truncated
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: paymentModelReference
|
||||
slug: /references/payment/models/Payment
|
||||
sidebar_label: Payment
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Payment - Payment Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the Payment . This belongs to the Payment Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"captured_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"refunds","type":"Collection<[Refund](../payment_models.Refund/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment","type":"[Payment](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"captured_at","type":"`null` \\| `Date`","description":"","optioLine truncated
|
||||
-13
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: paymentModelReference
|
||||
slug: /references/payment/models/PaymentCollection
|
||||
sidebar_label: PaymentCollection
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# PaymentCollection - Payment Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the PaymentCollection . This belongs to the Payment Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"authorized_amount","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_authorized_amount","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"captured_amount","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_captured_amount","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"refunded_amount","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_refunded_amount","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"completed_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)","description":"","optional":false,"defaultValue":"PaymentCollectionStatus.NOT_PAID","expandable":false,"children":[{"name":"NOT_PAID","type":"`\"not_paid\"`","description":"The payment collection isn't paid.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"AWAITING","type":"`\"awaiting\"`","description":"The payment collection is awaiting payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"AUTHORIZED","type":"`\"authorized\"`","description":"The payment collection is authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PARTIALLY_AUTHORIZED","type":"`\"partially_authorized\"`","description":"Some of the payments in the payment collection are authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The payment collection is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_providers","type":"Collection<[PaymentProvider](../payment_models.PaymentProvider/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`\"is_enabled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_sessions","type":"Collection<[PaymentSession](../payment_models.PaymentSession/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":fLine truncated
|
||||
-13
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: paymentModelReference
|
||||
slug: /references/payment/models/PaymentMethodToken
|
||||
sidebar_label: PaymentMethodToken
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# PaymentMethodToken - Payment Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the PaymentMethodToken . This belongs to the Payment Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type_detail","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"description_detail","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="PaymentMethodToken"/>
|
||||
-13
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: paymentModelReference
|
||||
slug: /references/payment/models/PaymentProvider
|
||||
sidebar_label: PaymentProvider
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# PaymentProvider - Payment Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the PaymentProvider . This belongs to the Payment Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`\"is_enabled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="PaymentProvider"/>
|
||||
-13
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: paymentModelReference
|
||||
slug: /references/payment/models/PaymentSession
|
||||
sidebar_label: PaymentSession
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# PaymentSession - Payment Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the PaymentSession . This belongs to the Payment Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"context","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentSessionStatus](../../../utils/enums/utils.PaymentSessionStatus/page.mdx)","description":"","optional":false,"defaultValue":"PaymentSessionStatus.PENDING","expandable":false,"children":[{"name":"AUTHORIZED","type":"`\"authorized\"`","description":"The payment is authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CAPTURED","type":"`\"captured\"`","description":"The payment is captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PENDING","type":"`\"pending\"`","description":"The payment is pending.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_MORE","type":"`\"requires_more\"`","description":"The payment requires an action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ERROR","type":"`\"error\"`","description":"An error occurred while processing the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The payment is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"authorized_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../payment_models.PaymentCollection/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"authorized_amount","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_authorized_amount","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"captured_amount","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_captured_amount","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"refunded_amount","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_refunded_amount","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":Line truncated
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: paymentModelReference
|
||||
slug: /references/payment/models/Refund
|
||||
sidebar_label: Refund
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Refund - Payment Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the Refund . This belongs to the Payment Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment","type":"[Payment](../payment_models.Payment/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"captured_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"refunds","type":"Collection<[Refund](page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../payment_models.Payment/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_reason_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"refund_reason","type":"`null` \\| [RefundReason](../payment_models.RefundReason/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"note","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]Line truncated
|
||||
-13
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: paymentModelReference
|
||||
slug: /references/payment/models/RefundReason
|
||||
sidebar_label: RefundReason
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# RefundReason - Payment Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the RefundReason . This belongs to the Payment Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="RefundReason"/>
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: paymentModelReference
|
||||
slug: /references/payment/models/Capture
|
||||
sidebar_label: Capture
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Capture - Payment Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the Capture data model. It belongs to the Payment Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the capture.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The captured amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"BelongsTo<[Payment](../payment_models.Payment/page.mdx)>","description":"The associated payment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo<[PaymentCollection](../payment_models.PaymentCollection/page.mdx)>","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the payment collection's region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)>","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany<[PaymentProvider](../payment_models.PaymentProvider/page.mdx)>","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"HasMany<[PaymentSession](../payment_models.PaymentSession/page.mdx)>","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"HasMany<[Payment](../payment_models.Payment/page.mdx)>","description":"The associated payments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"authorized_amount","type":"`BigNumberProperty`","description":"The authorized amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"`BigNumberProperty`","description":"The captured amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"`BigNumberProperty`","description":"The refunded amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the payment collection was completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_session","type":"BelongsTo<[PaymentSession](../payment_models.PaymentSession/page.mdx)>","description":"The associated payment session.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","tyLine truncated
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: paymentModelReference
|
||||
slug: /references/payment/models/Payment
|
||||
sidebar_label: Payment
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Payment - Payment Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the Payment data model. It belongs to the Payment Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo<[PaymentCollection](../payment_models.PaymentCollection/page.mdx)>","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the payment collection's region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)>","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany<[PaymentProvider](../payment_models.PaymentProvider/page.mdx)>","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collections","type":"ManyToMany<[PaymentCollection](../payment_models.PaymentCollection/page.mdx)>","description":"The associated payment collections.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"payment_sessions","type":"HasMany<[PaymentSession](../payment_models.PaymentSession/page.mdx)>","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment session that's useful for processing with third-party services. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PaymentSessionStatus](../../../utils/enums/utils.PaymentSessionStatus/page.mdx)>","description":"The status of the payment session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo<[PaymentCollection](../payment_models.PaymentCollection/page.mdx)>","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"context","type":"`JSONProperty`","description":"The context of the payment session, such as the billing address or the customer's email.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_at","type":"`DateTimeProperty`","description":"The date the payment session was authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"HasOne<[PaymentLine truncated
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: paymentModelReference
|
||||
slug: /references/payment/models/PaymentCollection
|
||||
sidebar_label: PaymentCollection
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# PaymentCollection - Payment Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the PaymentCollection data model. It belongs to the Payment Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the payment collection's region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)>","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany<[PaymentProvider](../payment_models.PaymentProvider/page.mdx)>","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collections","type":"ManyToMany<[PaymentCollection](page.mdx)>","description":"The associated payment collections.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the payment collection's region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)>","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany<[PaymentProvider](../payment_models.PaymentProvider/page.mdx)>","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"HasMany<[PaymentSession](../payment_models.PaymentSession/page.mdx)>","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"HasMany<[Payment](../payment_models.Payment/page.mdx)>","description":"The associated payments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"authorized_amount","type":"`BigNumberProperty`","description":"The authorized amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"`BigNumberProperty`","description":"The captured amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"`BigNumberProperty`","description":"The refunded amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the payment collection was completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"payment_sessions","type":"HasMany<[PaymentSession](../payment_models.PaymentSession/page.mdx)>","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"TLine truncated
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: paymentModelReference
|
||||
slug: /references/payment/models/PaymentMethodToken
|
||||
sidebar_label: PaymentMethodToken
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# PaymentMethodToken - Payment Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the PaymentMethodToken data model. It belongs to the Payment Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment method token.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider this token belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the associated saved payment method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment method token useful for retrieving the payment details from the third-party service.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type_detail","type":"`TextProperty`","description":"The details of the saved payment method's type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description_detail","type":"`TextProperty`","description":"The details of the saved payment method's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="PaymentMethodToken"/>
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: paymentModelReference
|
||||
slug: /references/payment/models/PaymentProvider
|
||||
sidebar_label: PaymentProvider
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# PaymentProvider - Payment Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the PaymentProvider data model. It belongs to the Payment Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collections","type":"ManyToMany<[PaymentCollection](../payment_models.PaymentCollection/page.mdx)>","description":"The associated payment collections.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the payment collection's region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)>","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany<[PaymentProvider](page.mdx)>","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collections","type":"ManyToMany<[PaymentCollection](../payment_models.PaymentCollection/page.mdx)>","description":"The associated payment collections.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"payment_sessions","type":"HasMany<[PaymentSession](../payment_models.PaymentSession/page.mdx)>","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment session that's useful for processing with third-party services. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PaymentSessionStatus](../../../utils/enums/utils.PaymentSessionStatus/page.mdx)>","description":"The status of the payment session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo<[PaymentCollection](../payment_models.PaymentCollection/page.mdx)>","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"context","type":"`JSONProperty`","description":"The context of the payment session, such as the billing address or the customer's email.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_at","type":"`DateTimeProperty`","description":"The date the payment session was authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"HasOne<[Payment](../payment_models.Payment/page.mdx)>","description":"The associated payment.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payments","type":"HasMany<[Payment](../payment_models.PLine truncated
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: paymentModelReference
|
||||
slug: /references/payment/models/PaymentSession
|
||||
sidebar_label: PaymentSession
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# PaymentSession - Payment Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the PaymentSession data model. It belongs to the Payment Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment session that's useful for processing with third-party services. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PaymentSessionStatus](../../../utils/enums/utils.PaymentSessionStatus/page.mdx)>","description":"The status of the payment session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo<[PaymentCollection](../payment_models.PaymentCollection/page.mdx)>","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the payment collection's region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)>","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany<[PaymentProvider](../payment_models.PaymentProvider/page.mdx)>","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collections","type":"ManyToMany<[PaymentCollection](../payment_models.PaymentCollection/page.mdx)>","description":"The associated payment collections.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"payment_sessions","type":"HasMany<[PaymentSession](page.mdx)>","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment session that's useful for processing with third-party services. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PaymentSessionStatus](../../../utils/enums/utils.PaymentSessionStatus/page.mdx)>","description":"The status of the payment session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo<[PaymentCollection](../payment_models.PaymentCollection/paLine truncated
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: paymentModelReference
|
||||
slug: /references/payment/models/Refund
|
||||
sidebar_label: Refund
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Refund - Payment Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the Refund data model. It belongs to the Payment Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the refund.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The refunded amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"BelongsTo<[Payment](../payment_models.Payment/page.mdx)>","description":"The associated payment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo<[PaymentCollection](../payment_models.PaymentCollection/page.mdx)>","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment collection.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`TextProperty`","description":"The ID of the payment collection's region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PaymentCollectionStatus](../../../utils/enums/utils.PaymentCollectionStatus/page.mdx)>","description":"The status of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"ManyToMany<[PaymentProvider](../payment_models.PaymentProvider/page.mdx)>","description":"The associated payment providers.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"HasMany<[PaymentSession](../payment_models.PaymentSession/page.mdx)>","description":"The associated payment sessions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"HasMany<[Payment](../payment_models.Payment/page.mdx)>","description":"The associated payments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"authorized_amount","type":"`BigNumberProperty`","description":"The authorized amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"`BigNumberProperty`","description":"The captured amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"`BigNumberProperty`","description":"The refunded amount of the payment collection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`DateTimeProperty`","description":"The date the payment collection was completed","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_session","type":"BelongsTo<[PaymentSession](../payment_models.PaymentSession/page.mdx)>","description":"The associated payment session.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment session.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment session.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The authorized amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","typLine truncated
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: paymentModelReference
|
||||
slug: /references/payment/models/RefundReason
|
||||
sidebar_label: RefundReason
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# RefundReason - Payment Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the RefundReason data model. It belongs to the Payment Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the refund reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`TextProperty`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"HasMany<[Refund](../payment_models.Refund/page.mdx)>","description":"The associated refunds.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the refund.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The refunded amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"BelongsTo<[Payment](../payment_models.Payment/page.mdx)>","description":"The associated payment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the payment.\n\n@example usd","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`TextProperty`","description":"The ID of the Payment Module Provider used to process the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"BelongsTo<[PaymentCollection](../payment_models.PaymentCollection/page.mdx)>","description":"The associated payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_session","type":"BelongsTo<[PaymentSession](../payment_models.PaymentSession/page.mdx)>","description":"The associated payment session.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"refunds","type":"HasMany<[Refund](../payment_models.Refund/page.mdx)>","description":"The associated refunds.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"captures","type":"HasMany<[Capture](../payment_models.Capture/page.mdx)>","description":"The associated captures.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`TextProperty`","description":"The ID of the cart this payment was created for","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`TextProperty`","description":"The ID of the order this payment was created for.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`TextProperty`","description":"The ID of the customer making the payment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`JSONProperty`","description":"The data of the payment that's useful for processing with third-party services. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property)","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`DateTimeProperty`","description":"The date that the payment was captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`DateTimeProperty`","description":"The date that the payment was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"refund_reason","type":"BelongsTo<[RefundReason](page.mdx)>","description":"The associated refund reason.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the refund reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`TextProperty`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"HasMany<[Refund](../payment_models.Refund/page.mdx)>","description":"The associated refunds.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"deLine truncated
|
||||
Reference in new issue
Block a user