chore(docs): Updated API Reference (v2) (#9437)
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>
This commit is contained in:
co-authored by
Shahed Nasser
parent
97c193be1b
commit
21badd069d
@@ -1,18 +1,16 @@
|
||||
type: object
|
||||
description: The transaction's transactions.
|
||||
description: The transaction's details.
|
||||
x-schemaName: OrderTransaction
|
||||
required:
|
||||
- id
|
||||
- order_id
|
||||
- order
|
||||
- amount
|
||||
- raw_amount
|
||||
- currency_code
|
||||
- reference
|
||||
- reference_id
|
||||
- metadata
|
||||
- created_at
|
||||
- updated_at
|
||||
- metadata
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
@@ -21,46 +19,40 @@ properties:
|
||||
order_id:
|
||||
type: string
|
||||
title: order_id
|
||||
description: The transaction's order id.
|
||||
order:
|
||||
type: object
|
||||
description: The ID of the order this transaction belongs to.
|
||||
amount:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: amount
|
||||
description: The transaction's amount.
|
||||
- type: number
|
||||
title: amount
|
||||
description: The transaction's amount.
|
||||
- type: string
|
||||
title: amount
|
||||
description: The transaction's amount.
|
||||
- $ref: ./IBigNumber.yaml
|
||||
raw_amount:
|
||||
type: object
|
||||
description: The transaction's raw amount.
|
||||
type: number
|
||||
title: amount
|
||||
description: The transaction's amount.
|
||||
currency_code:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The transaction's currency code.
|
||||
example: usd
|
||||
reference:
|
||||
type: string
|
||||
title: reference
|
||||
description: The transaction's reference.
|
||||
description: >-
|
||||
The name of a table that this transaction references. If this transaction
|
||||
is for captured payment, its value is `capture`. If this transaction is
|
||||
for refunded payment, its value is `refund`.
|
||||
enum:
|
||||
- capture
|
||||
- refund
|
||||
reference_id:
|
||||
type: string
|
||||
title: reference_id
|
||||
description: The transaction's reference id.
|
||||
description: The ID of the referenced record in the referenced table.
|
||||
metadata:
|
||||
type: object
|
||||
description: The transaction's metadata, can hold custom key-value pairs.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The transaction's created at.
|
||||
description: The date that the transaction was created.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The transaction's updated at.
|
||||
metadata:
|
||||
type: object
|
||||
description: The transaction's metadata.
|
||||
description: The date that the transaction was updated.
|
||||
|
||||
Reference in New Issue
Block a user