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:
github-actions[bot]
2024-10-03 07:48:54 +00:00
committed by GitHub
parent 97c193be1b
commit 21badd069d
894 changed files with 35649 additions and 28168 deletions

View File

@@ -1,5 +1,5 @@
type: object
description: The transaction's transactions.
description: An order transaction's details.
x-schemaName: BaseOrderTransaction
required:
- id
@@ -19,7 +19,7 @@ properties:
order_id:
type: string
title: order_id
description: The transaction's order id.
description: The ID of the order this transaction belongs to.
amount:
type: number
title: amount
@@ -28,24 +28,31 @@ properties:
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.
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.
description: The date that the transaction was updated.