7963c16233
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
120 lines
3.4 KiB
YAML
120 lines
3.4 KiB
YAML
title: Payment
|
|
description: >-
|
|
Payments represent an amount authorized with a given payment method, Payments
|
|
can be captured, canceled or refunded.
|
|
type: object
|
|
required:
|
|
- amount
|
|
- amount_refunded
|
|
- canceled_at
|
|
- captured_at
|
|
- cart_id
|
|
- created_at
|
|
- currency_code
|
|
- data
|
|
- id
|
|
- idempotency_key
|
|
- metadata
|
|
- order_id
|
|
- provider_id
|
|
- swap_id
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
description: The payment's ID
|
|
type: string
|
|
example: pay_01G2SJNT6DEEWDFNAJ4XWDTHKE
|
|
swap_id:
|
|
description: The ID of the Swap that the Payment is used for.
|
|
nullable: true
|
|
type: string
|
|
example: null
|
|
swap:
|
|
description: A swap object. Available if the relation `swap` is expanded.
|
|
nullable: true
|
|
type: object
|
|
cart_id:
|
|
description: The id of the Cart that the Payment Session is created for.
|
|
nullable: true
|
|
type: string
|
|
cart:
|
|
description: A cart object. Available if the relation `cart` is expanded.
|
|
nullable: true
|
|
type: object
|
|
order_id:
|
|
description: The ID of the Order that the Payment is used for.
|
|
nullable: true
|
|
type: string
|
|
example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
|
|
order:
|
|
description: An order object. Available if the relation `order` is expanded.
|
|
nullable: true
|
|
type: object
|
|
amount:
|
|
description: The amount that the Payment has been authorized for.
|
|
type: integer
|
|
example: 100
|
|
currency_code:
|
|
description: The 3 character ISO currency code that the Payment is completed in.
|
|
type: string
|
|
example: usd
|
|
externalDocs:
|
|
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
|
|
description: See a list of codes.
|
|
currency:
|
|
description: Available if the relation `currency` is expanded.
|
|
nullable: true
|
|
$ref: ./Currency.yaml
|
|
amount_refunded:
|
|
description: >-
|
|
The amount of the original Payment amount that has been refunded back to
|
|
the Customer.
|
|
type: integer
|
|
default: 0
|
|
example: 0
|
|
provider_id:
|
|
description: The id of the Payment Provider that is responsible for the Payment
|
|
type: string
|
|
example: manual
|
|
data:
|
|
description: >-
|
|
The data required for the Payment Provider to identify, modify and process
|
|
the Payment. Typically this will be an object that holds an id to the
|
|
external payment session, but can be an empty object if the Payment
|
|
Provider doesn't hold any state.
|
|
type: object
|
|
example: {}
|
|
captured_at:
|
|
description: The date with timezone at which the Payment was captured.
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|
|
canceled_at:
|
|
description: The date with timezone at which the Payment was canceled.
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|
|
idempotency_key:
|
|
description: >-
|
|
Randomly generated key used to continue the completion of a payment in
|
|
case of failure.
|
|
nullable: true
|
|
type: string
|
|
externalDocs:
|
|
url: https://docs.medusajs.com/development/idempotency-key/overview.md
|
|
description: Learn more how to use the idempotency key.
|
|
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
|
|
metadata:
|
|
description: An optional key-value map with additional details
|
|
nullable: true
|
|
type: object
|
|
example:
|
|
car: white
|