diff options
Diffstat (limited to 'jb-ui/src/api_fsb/docs/UserLedgerWallet.md')
| -rw-r--r-- | jb-ui/src/api_fsb/docs/UserLedgerWallet.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/UserLedgerWallet.md b/jb-ui/src/api_fsb/docs/UserLedgerWallet.md new file mode 100644 index 0000000..d223586 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserLedgerWallet.md @@ -0,0 +1,37 @@ +# UserLedgerWallet + +A user-owned ledger account exposed by the wallets endpoint. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount** | **number** | (USD cents) The amount in the user\'s wallet. | [default to undefined] +**redeemable_amount** | **number** | (USD cents) The amount in the user\'s wallet this is currently redeemable. | [default to undefined] +**payout_format** | **string** | | [optional] [default to undefined] +**amount_string** | **string** | | [optional] [default to undefined] +**redeemable_amount_string** | **string** | | [optional] [default to undefined] +**account_uuid** | **string** | A unique identifier for this Ledger Account | [default to undefined] +**account_type** | **string** | | [default to undefined] +**currency** | **string** | | [optional] [default to 'USD'] +**display_name** | **string** | Human-readable description of the Ledger Account | [default to undefined] + +## Example + +```typescript +import { UserLedgerWallet } from './api'; + +const instance: UserLedgerWallet = { + amount, + redeemable_amount, + payout_format, + amount_string, + redeemable_amount_string, + account_uuid, + account_type, + currency, + display_name, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |