Files
medusa-store/www/apps/api-reference/specs/admin/components/schemas/AdminPayment.yaml
github-actions[bot] b23ddcdde8 chore(docs): Updated API Reference (v2) (#8609)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-08-15 14:31:35 +00:00

131 lines
3.3 KiB
YAML

type: object
description: The payment's details.
x-schemaName: AdminPayment
required:
- id
- amount
- currency_code
- provider_id
properties:
id:
type: string
title: id
description: The payment's ID.
amount:
oneOf:
- type: string
title: amount
description: The payment's amount.
- type: number
title: amount
description: The payment's amount.
- type: string
title: amount
description: The payment's amount.
- $ref: ./IBigNumber.yaml
authorized_amount:
oneOf:
- type: string
title: authorized_amount
description: The payment's authorized amount.
- type: number
title: authorized_amount
description: The payment's authorized amount.
- type: string
title: authorized_amount
description: The payment's authorized amount.
- $ref: ./IBigNumber.yaml
currency_code:
type: string
title: currency_code
description: The payment's currency code.
provider_id:
type: string
title: provider_id
description: The payment's provider id.
cart_id:
type: string
title: cart_id
description: The payment's cart id.
order_id:
type: string
title: order_id
description: The payment's order id.
order_edit_id:
type: string
title: order_edit_id
description: The payment's order edit id.
customer_id:
type: string
title: customer_id
description: The payment's customer id.
data:
type: object
description: The payment's data.
created_at:
type: string
format: date-time
title: created_at
description: The payment's created at.
updated_at:
type: string
format: date-time
title: updated_at
description: The payment's updated at.
captured_at:
oneOf:
- type: string
title: captured_at
description: The payment's captured at.
- type: string
title: captured_at
description: The payment's captured at.
format: date-time
canceled_at:
oneOf:
- type: string
title: canceled_at
description: The payment's canceled at.
- type: string
title: canceled_at
description: The payment's canceled at.
format: date-time
captured_amount:
oneOf:
- type: string
title: captured_amount
description: The payment's captured amount.
- type: number
title: captured_amount
description: The payment's captured amount.
- type: string
title: captured_amount
description: The payment's captured amount.
- $ref: ./IBigNumber.yaml
refunded_amount:
oneOf:
- type: string
title: refunded_amount
description: The payment's refunded amount.
- type: number
title: refunded_amount
description: The payment's refunded amount.
- type: string
title: refunded_amount
description: The payment's refunded amount.
- $ref: ./IBigNumber.yaml
captures:
type: array
description: The payment's captures.
items:
$ref: ./BaseCapture.yaml
refunds:
type: array
description: The payment's refunds.
items:
$ref: ./BaseRefund.yaml
payment_collection:
$ref: ./BasePaymentCollection.yaml
payment_session:
$ref: ./BasePaymentSession.yaml