aboutsummaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/BrokerageProductPayoutEvent.md
diff options
context:
space:
mode:
authorMax Nanis2026-02-18 20:42:03 -0500
committerMax Nanis2026-02-18 20:42:03 -0500
commit3eaa56f0306ead818f64c3d99fc6d230d9b970a4 (patch)
tree9fecc2f1456e6321572e0e65f57106916df173e2 /jb-ui/src/api_fsb/docs/BrokerageProductPayoutEvent.md
downloadamt-jb-3eaa56f0306ead818f64c3d99fc6d230d9b970a4.tar.gz
amt-jb-3eaa56f0306ead818f64c3d99fc6d230d9b970a4.zip
HERE WE GO, HERE WE GO, HERE WE GO
Diffstat (limited to 'jb-ui/src/api_fsb/docs/BrokerageProductPayoutEvent.md')
-rw-r--r--jb-ui/src/api_fsb/docs/BrokerageProductPayoutEvent.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/BrokerageProductPayoutEvent.md b/jb-ui/src/api_fsb/docs/BrokerageProductPayoutEvent.md
new file mode 100644
index 0000000..c2d2ca6
--- /dev/null
+++ b/jb-ui/src/api_fsb/docs/BrokerageProductPayoutEvent.md
@@ -0,0 +1,47 @@
+# BrokerageProductPayoutEvent
+
+The amount - created: When the Brokerage Product was paid out
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** | | [optional] [default to undefined]
+**debit_account_uuid** | **string** | The LedgerAccount.uuid that money is being requested from. Thie User or Brokerage Product is retrievable through the LedgerAccount.reference_uuid | [default to undefined]
+**cashout_method_uuid** | **string** | References a row in the account_cashoutmethod table. This is the cashout method that was used to request this payout. (A cashout is the same thing as a payout) | [default to undefined]
+**created** | **string** | | [optional] [default to undefined]
+**amount** | **number** | The USDCent amount int. This cannot be 0 or negative | [default to undefined]
+**status** | [**PayoutStatus**](PayoutStatus.md) | | [optional] [default to undefined]
+**ext_ref_id** | **string** | | [optional] [default to undefined]
+**payout_type** | [**PayoutType**](PayoutType.md) | - `PAYPAL` = PAYPAL - `TANGO` = TANGO - `DWOLLA` = DWOLLA - `ACH` = ACH - `WIRE` = WIRE - `CASH_IN_MAIL` = CASH_IN_MAIL - `PRIZE` = PRIZE - `AMT` = AMT - `AMT_BONUS` = AMT_BONUS - `AMT_ASSIGNMENT` = AMT_HIT | [default to undefined]
+**request_data** | **object** | Stores payout-type-specific information that is used to request this payout from the external provider. | [optional] [default to undefined]
+**order_data** | [**OrderData**](OrderData.md) | | [optional] [default to undefined]
+**product_id** | **string** | The Brokerage Product that was paid out | [default to undefined]
+**method** | [**PayoutType**](PayoutType.md) | - `PAYPAL` = PAYPAL - `TANGO` = TANGO - `DWOLLA` = DWOLLA - `ACH` = ACH - `WIRE` = WIRE - `CASH_IN_MAIL` = CASH_IN_MAIL - `PRIZE` = PRIZE - `AMT` = AMT - `AMT_BONUS` = AMT_BONUS - `AMT_ASSIGNMENT` = AMT_HIT | [readonly] [default to undefined]
+**amount_usd** | **number** | | [readonly] [default to undefined]
+**amount_usd_str** | **string** | | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { BrokerageProductPayoutEvent } from './api';
+
+const instance: BrokerageProductPayoutEvent = {
+ uuid,
+ debit_account_uuid,
+ cashout_method_uuid,
+ created,
+ amount,
+ status,
+ ext_ref_id,
+ payout_type,
+ request_data,
+ order_data,
+ product_id,
+ method,
+ amount_usd,
+ amount_usd_str,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)