aboutsummaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/BrokerageProductPayoutEvent.md
blob: c2d2ca6d87fa6ba9df938d134f1f9d1ef222270c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
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)