Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add walled transaction metadata #259

Merged
merged 4 commits into from
Aug 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 110 additions & 0 deletions openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

34 changes: 34 additions & 0 deletions src/schemas/WalletCreateInput.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,23 @@ properties:
type: boolean
description: A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
example: false
transaction_metadata:
type: array
description: This optional field allows you to store a list of key-value pairs that provide additional information or custom attributes. These key-value pairs will be included in the metadata of wallet transactions generated during the wallet creation process.
items:
type: object
properties:
key:
type: string
description: The unique identifier for the attribute.
value:
type: string
description: The corresponding value for the key.
example:
- key: "example_key"
value: "example_value"
- key: "another_key"
value: "another_value"
recurring_transaction_rules:
type: array
description: List of recurring transaction rules. Currently, we only allow one recurring rule per wallet.
Expand Down Expand Up @@ -110,3 +127,20 @@ properties:
type: boolean
description: A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
example: false
transaction_metadata:
type: array
description: This optional field allows you to store a list of key-value pairs containing additional information or custom attributes. These key-value pairs will populate the metadata of the wallet transactions triggered by this rule.
items:
type: object
properties:
key:
type: string
description: The unique identifier for the attribute.
value:
type: string
description: The value associated with the key.
example:
- key: "example_key"
value: "example_value"
- key: "another_key"
value: "another_value"
18 changes: 18 additions & 0 deletions src/schemas/WalletRecurringTransactionRule.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -73,3 +73,21 @@ properties:
type: boolean
description: A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
example: false

transaction_metadata:
type: array
description: This field allows you to store a list of key-value pairs containing additional information or custom attributes. These key-value pairs will populate the metadata of the wallet transactions triggered by this rule.
items:
type: object
properties:
key:
type: string
description: The unique identifier for the attribute.
value:
type: string
description: The value associated with the key.
example:
- key: "example_key"
value: "example_value"
- key: "another_key"
value: "another_value"
17 changes: 17 additions & 0 deletions src/schemas/WalletTransactionCreateInput.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,20 @@ properties:
type: boolean
description: A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
example: false
metadata:
type: array
description: This optional field allows you to store a list of key-value pairs that hold additional information or custom attributes related to the data.
items:
type: object
properties:
key:
type: string
description: The unique identifier for the attribute.
value:
type: string
description: The value associated with the key.
example:
- key: "example key"
value: "example value"
- key: "another key"
value: "another value"
25 changes: 25 additions & 0 deletions src/schemas/WalletTransactionObject.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@ properties:
- settled
description: The status of the wallet transaction. Possible values are `pending` or `settled`.
example: settled
source:
type: string
enum:
- manual
- interval
- threshold
description: The source field represents the origin or trigger of the wallet transaction. Possible values are `manual`, `interval`. `threshold`
example: manual
transaction_status:
type: string
enum:
Expand Down Expand Up @@ -56,6 +64,23 @@ properties:
type: boolean
description: A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
example: false
metadata:
type: array
description: This field allows you to store a list of key-value pairs that hold additional information or custom attributes related to the data.
items:
type: object
properties:
key:
type: string
description: The unique identifier for the attribute.
value:
type: string
description: The value associated with the key.
example:
- key: "example key"
value: "example value"
- key: "another key"
value: "another value"
settled_at:
type: string
format: 'date-time'
Expand Down
18 changes: 18 additions & 0 deletions src/schemas/WalletUpdateInput.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,21 @@ properties:
type: boolean
description: A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.
example: false
transaction_metadata:
type: array
description: This optional field allows you to store a list of key-value pairs containing additional information or custom attributes. These key-value pairs will populate the metadata of the wallet transactions triggered by this rule.
items:
type: object
properties:
key:
type: string
description: The unique identifier for the attribute.
value:
type: string
description: The value associated with the key.
example:
- key: "example_key"
value: "example_value"
- key: "another_key"
value: "another_value"

Loading