path: root/jb-ui/src/api_fsb/docs/WalletApi.md

# WalletApi

All URIs are relative to *https://fsb.generalresearch.com*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createCashoutMethodProductIdCashoutMethodsPost**](#createcashoutmethodproductidcashoutmethodspost) | **POST** /{product_id}/cashout_methods/ | Create Cashout Method|
|[**deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete**](#deletecashoutmethodproductidcashoutmethodscashoutmethodiddelete) | **DELETE** /{product_id}/cashout_methods/{cashout_method_id}/ | Delete Cashout Method|
|[**getCashoutDetailProductIdCashoutCashoutIdGet**](#getcashoutdetailproductidcashoutcashoutidget) | **GET** /{product_id}/cashout/{cashout_id}/ | Get Cashout Detail|
|[**getCashoutMethodsProductIdCashoutMethodsGet**](#getcashoutmethodsproductidcashoutmethodsget) | **GET** /{product_id}/cashout_methods/ | Get Cashout Methods|
|[**getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet**](#getexpectedredemptionvalueproductidcashoutmethodcashoutmethodidvalueget) | **GET** /{product_id}/cashout_method/{cashout_method_id}/value/ | Get Expected Redemption Value|
|[**getUserTransactionHistoryProductIdTransactionHistoryGet**](#getusertransactionhistoryproductidtransactionhistoryget) | **GET** /{product_id}/transaction_history/ | Get User Transaction History|
|[**getUserWalletBalanceProductIdWalletGet**](#getuserwalletbalanceproductidwalletget) | **GET** /{product_id}/wallet/ | Get User Wallet Balance|
|[**submitUserCashoutProductIdCashoutPost**](#submitusercashoutproductidcashoutpost) | **POST** /{product_id}/cashout/ | Submit User Cashout|

# **createCashoutMethodProductIdCashoutMethodsPost**
> CashoutMethodResponse createCashoutMethodProductIdCashoutMethodsPost(body)

A user can only have 1 unique Cashout Method of any type at a time (eg. they can\'t create multiple paypal payout methods). Cashout Methods cannot be edited, they can only be created or deleted. Creating different Cashout Methods will require type-dependent request data attributes in order to be successfully created.  Currently only creating paypal or Cash in Mail cashout methods are supported

### Example

```typescript
import {
    WalletApi,
    Configuration,
    Body
} from './api';

const configuration = new Configuration();
const apiInstance = new WalletApi(configuration);

let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined)
let body: Body; //

const { status, data } = await apiInstance.createCashoutMethodProductIdCashoutMethodsPost(
    productId,
    body
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **Body**|  | |
| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined|


### Return type

**CashoutMethodResponse**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete**
> StatusResponse deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete()

Delete a cashout method

### Example

```typescript
import {
    WalletApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new WalletApi(configuration);

let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined)
let cashoutMethodId: string; //The ID of the cashout method to delete (default to undefined)
let bpuid: string; //A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. (default to undefined)

const { status, data } = await apiInstance.deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete(
    productId,
    cashoutMethodId,
    bpuid
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined|
| **cashoutMethodId** | [**string**] | The ID of the cashout method to delete | defaults to undefined|
| **bpuid** | [**string**] | A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. | defaults to undefined|


### Return type

**StatusResponse**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getCashoutDetailProductIdCashoutCashoutIdGet**
> CashoutRequestResponse getCashoutDetailProductIdCashoutCashoutIdGet()

Retrieve the details for a specific Cashout event

### Example

```typescript
import {
    WalletApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new WalletApi(configuration);

let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined)
let cashoutId: string; //The cashout event ID (default to undefined)

const { status, data } = await apiInstance.getCashoutDetailProductIdCashoutCashoutIdGet(
    productId,
    cashoutId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined|
| **cashoutId** | [**string**] | The cashout event ID | defaults to undefined|


### Return type

**CashoutRequestResponse**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getCashoutMethodsProductIdCashoutMethodsGet**
> CashoutMethodsResponse getCashoutMethodsProductIdCashoutMethodsGet()

Retrieve the current available mechanisms that a user can use to retrieve funds.

### Example

```typescript
import {
    WalletApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new WalletApi(configuration);

let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined)
let bpuid: string; //A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. (default to undefined)

const { status, data } = await apiInstance.getCashoutMethodsProductIdCashoutMethodsGet(
    productId,
    bpuid
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined|
| **bpuid** | [**string**] | A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. | defaults to undefined|


### Return type

**CashoutMethodsResponse**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet**
> CashoutMethodForeignValueResponse getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet()

Use this function to get the \"value\" (in local currency, e.g. CAD, BTC) for this   cashout_method, for amount (in USD cents).

### Example

```typescript
import {
    WalletApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new WalletApi(configuration);

let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined)
let cashoutMethodId: string; //The ID of the cashout method (default to undefined)
let amount: number; //(USD cents) The amount to convert (default to undefined)

const { status, data } = await apiInstance.getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet(
    productId,
    cashoutMethodId,
    amount
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined|
| **cashoutMethodId** | [**string**] | The ID of the cashout method | defaults to undefined|
| **amount** | [**number**] | (USD cents) The amount to convert | defaults to undefined|


### Return type

**CashoutMethodForeignValueResponse**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getUserTransactionHistoryProductIdTransactionHistoryGet**
> UserLedgerTransactionsResponse getUserTransactionHistoryProductIdTransactionHistoryGet()

Return array of user events that altered their wallet balance

### Example

```typescript
import {
    WalletApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new WalletApi(configuration);

let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined)
let bpuid: string; //A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. (default to undefined)
let createdAfter: string; //Filter transactions created after this timestamp (optional) (default to undefined)
let createdBefore: string; //Filter transactions created before this timestamp (optional) (default to undefined)
let orderBy: string; //Comma-separated fields to order by (optional) (default to 'created')
let page: number; // (optional) (default to 1)
let size: number; // (optional) (default to 50)

const { status, data } = await apiInstance.getUserTransactionHistoryProductIdTransactionHistoryGet(
    productId,
    bpuid,
    createdAfter,
    createdBefore,
    orderBy,
    page,
    size
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined|
| **bpuid** | [**string**] | A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. | defaults to undefined|
| **createdAfter** | [**string**] | Filter transactions created after this timestamp | (optional) defaults to undefined|
| **createdBefore** | [**string**] | Filter transactions created before this timestamp | (optional) defaults to undefined|
| **orderBy** | [**string**] | Comma-separated fields to order by | (optional) defaults to 'created'|
| **page** | [**number**] |  | (optional) defaults to 1|
| **size** | [**number**] |  | (optional) defaults to 50|


### Return type

**UserLedgerTransactionsResponse**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getUserWalletBalanceProductIdWalletGet**
> UserWalletBalanceResponse getUserWalletBalanceProductIdWalletGet()

Retrieve the current balance of a respondent\'s wallet balance for display

### Example

```typescript
import {
    WalletApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new WalletApi(configuration);

let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined)
let bpuid: string; //A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. (default to undefined)

const { status, data } = await apiInstance.getUserWalletBalanceProductIdWalletGet(
    productId,
    bpuid
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined|
| **bpuid** | [**string**] | A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. | defaults to undefined|


### Return type

**UserWalletBalanceResponse**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **submitUserCashoutProductIdCashoutPost**
> CashoutRequestResponse submitUserCashoutProductIdCashoutPost(createCashoutRequest)

Request a cashout taken from a user\'s available wallet balance, to be paid via a particular cashout method.

### Example

```typescript
import {
    WalletApi,
    Configuration,
    CreateCashoutRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new WalletApi(configuration);

let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined)
let createCashoutRequest: CreateCashoutRequest; //

const { status, data } = await apiInstance.submitUserCashoutProductIdCashoutPost(
    productId,
    createCashoutRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **createCashoutRequest** | **CreateCashoutRequest**|  | |
| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined|


### Return type

**CashoutRequestResponse**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)