# DepositTransactionsApi

All URIs are relative to *http://localhost:8889/api*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**adjust**](#adjust) | **POST** /deposits/transactions/{depositTransactionId}:adjust | Adjust a deposit transaction, which may bulk adjust multiple transactions|
|[**applyFee**](#applyfee) | **POST** /deposits/{depositAccountId}/fee-transactions | Apply a fee on a deposit account|
|[**editTransactionDetails**](#edittransactiondetails) | **PATCH** /deposits/transactions/{depositTransactionId} | Edit custom information or notes for deposit transaction|
|[**getAll**](#getall) | **GET** /deposits/{depositAccountId}/transactions | Get deposit transactions|
|[**getById**](#getbyid) | **GET** /deposits/transactions/{depositTransactionId} | Get deposit transaction|
|[**makeBulkDeposits**](#makebulkdeposits) | **POST** /deposits/deposit-transactions:bulk | Create bulk deposit transactions.|
|[**makeDeposit**](#makedeposit) | **POST** /deposits/{depositAccountId}/deposit-transactions | Create deposit transaction|
|[**makeSeizure**](#makeseizure) | **POST** /deposits/{depositAccountId}/seizure-transactions | Seize a block amount on a deposit account|
|[**makeTransfer**](#maketransfer) | **POST** /deposits/{depositAccountId}/transfer-transactions | Create transfer transaction|
|[**makeWithdrawal**](#makewithdrawal) | **POST** /deposits/{depositAccountId}/withdrawal-transactions | Create withdrawal transaction|
|[**search**](#search) | **POST** /deposits/transactions:search | Search deposit transactions for deposit accounts by various criteria|

# **adjust**
> DepositTransaction adjust(depositTransactionAdjustmentDetails)


### Example

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

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

let depositTransactionId: string; //The ID or encoded key of the deposit transaction. (default to undefined)
let depositTransactionAdjustmentDetails: DepositTransactionAdjustmentDetails; //Represents information about the adjustment action.
let idempotencyKey: string; //Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting. (optional) (default to undefined)

const { status, data } = await apiInstance.adjust(
    depositTransactionId,
    depositTransactionAdjustmentDetails,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositTransactionAdjustmentDetails** | **DepositTransactionAdjustmentDetails**| Represents information about the adjustment action. | |
| **depositTransactionId** | [**string**] | The ID or encoded key of the deposit transaction. | defaults to undefined|
| **idempotencyKey** | [**string**] | Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting. | (optional) defaults to undefined|


### Return type

**DepositTransaction**

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**102** | Your idempotent request was already submitted and is currently being processed, try again later. |  -  |
|**200** | The deposit transaction has been adjusted. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | The deposit transaction was not found. |  -  |
|**409** | Operation cannot be performed due to another pending operation that locked shared resources. |  -  |

[[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)

# **applyFee**
> DepositTransaction applyFee(feeAppliedDepositTransactionInput)


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit that the transaction will be created for. (default to undefined)
let feeAppliedDepositTransactionInput: FeeAppliedDepositTransactionInput; //Represents the information for creating a `FEE_APPLIED` type transaction on a deposit.
let idempotencyKey: string; //Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting. (optional) (default to undefined)

const { status, data } = await apiInstance.applyFee(
    depositAccountId,
    feeAppliedDepositTransactionInput,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **feeAppliedDepositTransactionInput** | **FeeAppliedDepositTransactionInput**| Represents the information for creating a `FEE_APPLIED` type transaction on a deposit. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit that the transaction will be created for. | defaults to undefined|
| **idempotencyKey** | [**string**] | Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting. | (optional) defaults to undefined|


### Return type

**DepositTransaction**

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**102** | Your idempotent request was already submitted and is currently being processed, try again later. |  -  |
|**201** | The fee applied transaction has been created. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | The deposit account was not found. |  -  |
|**409** | Operation cannot be performed due to another pending operation that locked shared resources. |  -  |
|**429** | Too Many Requests |  -  |

[[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)

# **editTransactionDetails**
> editTransactionDetails(patchOperation)


### Example

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

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

let depositTransactionId: string; //The ID or encoded key of the deposit transaction. (default to undefined)
let patchOperation: Array<PatchOperation>; //Patch operations to be applied to a resource.

const { status, data } = await apiInstance.editTransactionDetails(
    depositTransactionId,
    patchOperation
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **patchOperation** | **Array<PatchOperation>**| Patch operations to be applied to a resource. | |
| **depositTransactionId** | [**string**] | The ID or encoded key of the deposit transaction. | defaults to undefined|


### Return type

void (empty response body)

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | The deposit transaction details have been edited successfully. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | The deposit account was not found. |  -  |

[[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)

# **getAll**
> Array<DepositTransaction> getAll()


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account used to get all of its transactions. (default to undefined)
let offset: number; //Pagination, index to start searching at when retrieving elements, used in combination with limit to paginate results (optional) (default to undefined)
let limit: number; //Pagination, the number of elements to retrieve, used in combination with offset to paginate results (optional) (default to undefined)
let paginationDetails: 'ON' | 'OFF'; //Flag specifying whether the pagination  details should be provided in response headers. Please note that by default it is disabled (OFF), in order to improve the performance of the APIs (optional) (default to 'OFF')
let detailsLevel: 'BASIC' | 'FULL'; //The level of details to return: `FULL` means the full details of the object will be returned (custom field values, address, contact info, or any other related objects) and `BASIC` will return only the first level elements of the object. (optional) (default to undefined)

const { status, data } = await apiInstance.getAll(
    depositAccountId,
    offset,
    limit,
    paginationDetails,
    detailsLevel
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account used to get all of its transactions. | defaults to undefined|
| **offset** | [**number**] | Pagination, index to start searching at when retrieving elements, used in combination with limit to paginate results | (optional) defaults to undefined|
| **limit** | [**number**] | Pagination, the number of elements to retrieve, used in combination with offset to paginate results | (optional) defaults to undefined|
| **paginationDetails** | [**&#39;ON&#39; | &#39;OFF&#39;**]**Array<&#39;ON&#39; &#124; &#39;OFF&#39;>** | Flag specifying whether the pagination  details should be provided in response headers. Please note that by default it is disabled (OFF), in order to improve the performance of the APIs | (optional) defaults to 'OFF'|
| **detailsLevel** | [**&#39;BASIC&#39; | &#39;FULL&#39;**]**Array<&#39;BASIC&#39; &#124; &#39;FULL&#39;>** | The level of details to return: &#x60;FULL&#x60; means the full details of the object will be returned (custom field values, address, contact info, or any other related objects) and &#x60;BASIC&#x60; will return only the first level elements of the object. | (optional) defaults to undefined|


### Return type

**Array<DepositTransaction>**

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | The list of deposit transactions has been returned. |  * Items-Limit - Pagination details, the requested page size <br>  * Items-Offset - Pagination details, the index of the first returned item <br>  * Items-Total - Pagination details, the total available items <br>  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |

[[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)

# **getById**
> DepositTransaction getById()


### Example

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

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

let depositTransactionId: string; //The ID or encoded key of the deposit transaction. (default to undefined)
let detailsLevel: 'BASIC' | 'FULL'; //The level of details to return: `FULL` means the full details of the object will be returned (custom field values, address, contact info, or any other related objects) and `BASIC` will return only the first level elements of the object. (optional) (default to undefined)

const { status, data } = await apiInstance.getById(
    depositTransactionId,
    detailsLevel
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositTransactionId** | [**string**] | The ID or encoded key of the deposit transaction. | defaults to undefined|
| **detailsLevel** | [**&#39;BASIC&#39; | &#39;FULL&#39;**]**Array<&#39;BASIC&#39; &#124; &#39;FULL&#39;>** | The level of details to return: &#x60;FULL&#x60; means the full details of the object will be returned (custom field values, address, contact info, or any other related objects) and &#x60;BASIC&#x60; will return only the first level elements of the object. | (optional) defaults to undefined|


### Return type

**DepositTransaction**

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | The deposit transaction has been returned. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | The deposit transaction was not found. |  -  |

[[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)

# **makeBulkDeposits**
> makeBulkDeposits(bulkDepositTransactionsInput)


### Example

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

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

let bulkDepositTransactionsInput: BulkDepositTransactionsInput; //Represents the information for making bulk deposit transactions.
let idempotencyKey: string; //Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting. (optional) (default to undefined)

const { status, data } = await apiInstance.makeBulkDeposits(
    bulkDepositTransactionsInput,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **bulkDepositTransactionsInput** | **BulkDepositTransactionsInput**| Represents the information for making bulk deposit transactions. | |
| **idempotencyKey** | [**string**] | Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting. | (optional) defaults to undefined|


### Return type

void (empty response body)

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**102** | Your idempotent request was already submitted and is currently being processed, try again later. |  -  |
|**202** | The bulk deposit transactions have been created. |  * Location - Bulk process key <br>  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |

[[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)

# **makeDeposit**
> DepositTransaction makeDeposit(depositTransactionInput)


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit that the transaction will be created for. (default to undefined)
let depositTransactionInput: DepositTransactionInput; //Represents the information needed to create a deposit transaction.
let idempotencyKey: string; //Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting. (optional) (default to undefined)

const { status, data } = await apiInstance.makeDeposit(
    depositAccountId,
    depositTransactionInput,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositTransactionInput** | **DepositTransactionInput**| Represents the information needed to create a deposit transaction. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit that the transaction will be created for. | defaults to undefined|
| **idempotencyKey** | [**string**] | Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting. | (optional) defaults to undefined|


### Return type

**DepositTransaction**

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**102** | Your idempotent request was already submitted and is currently being processed, try again later. |  -  |
|**201** | The deposit transaction has been created. |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | The deposit account was not found. |  -  |
|**409** | Operation cannot be performed due to another pending operation that locked shared resources. |  -  |
|**429** | Too Many Requests |  -  |

[[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)

# **makeSeizure**
> DepositTransaction makeSeizure(seizeBlockAmount)


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit that the transaction will be created for. (default to undefined)
let seizeBlockAmount: SeizeBlockAmount; //Represents the information for seizing a block amount on a deposit account.
let idempotencyKey: string; //Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting. (optional) (default to undefined)

const { status, data } = await apiInstance.makeSeizure(
    depositAccountId,
    seizeBlockAmount,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seizeBlockAmount** | **SeizeBlockAmount**| Represents the information for seizing a block amount on a deposit account. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit that the transaction will be created for. | defaults to undefined|
| **idempotencyKey** | [**string**] | Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting. | (optional) defaults to undefined|


### Return type

**DepositTransaction**

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**102** | Your idempotent request was already submitted and is currently being processed, try again later. |  -  |
|**201** | The seized amount transaction has been created. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | The deposit account was not found. |  -  |
|**409** | Operation cannot be performed due to another pending operation that locked shared resources. |  -  |
|**429** | Too Many Requests |  -  |

[[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)

# **makeTransfer**
> DepositTransaction makeTransfer(transferDepositTransactionInput)


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit that the transaction will be created for. (default to undefined)
let transferDepositTransactionInput: TransferDepositTransactionInput; //Represents the information needed for a transfer transaction.
let idempotencyKey: string; //Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting. (optional) (default to undefined)

const { status, data } = await apiInstance.makeTransfer(
    depositAccountId,
    transferDepositTransactionInput,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **transferDepositTransactionInput** | **TransferDepositTransactionInput**| Represents the information needed for a transfer transaction. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit that the transaction will be created for. | defaults to undefined|
| **idempotencyKey** | [**string**] | Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting. | (optional) defaults to undefined|


### Return type

**DepositTransaction**

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**102** | Your idempotent request was already submitted and is currently being processed, try again later. |  -  |
|**201** | The transfer transaction has been created. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | The deposit account was not found. |  -  |
|**409** | Operation cannot be performed due to another pending operation that locked shared resources. |  -  |
|**429** | Too Many Requests |  -  |

[[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)

# **makeWithdrawal**
> DepositTransaction makeWithdrawal(withdrawalDepositTransactionInput)


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit that the transaction will be created for. (default to undefined)
let withdrawalDepositTransactionInput: WithdrawalDepositTransactionInput; //Represents the information for a withdrawal transaction.
let idempotencyKey: string; //Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting. (optional) (default to undefined)

const { status, data } = await apiInstance.makeWithdrawal(
    depositAccountId,
    withdrawalDepositTransactionInput,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **withdrawalDepositTransactionInput** | **WithdrawalDepositTransactionInput**| Represents the information for a withdrawal transaction. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit that the transaction will be created for. | defaults to undefined|
| **idempotencyKey** | [**string**] | Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting. | (optional) defaults to undefined|


### Return type

**DepositTransaction**

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**102** | Your idempotent request was already submitted and is currently being processed, try again later. |  -  |
|**201** | The withdrawal transaction has been created. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | The deposit account was not found. |  -  |
|**409** | Operation cannot be performed due to another pending operation that locked shared resources. |  -  |
|**429** | Too Many Requests |  -  |

[[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)

# **search**
> Array<DepositTransaction> search(depositTransactionSearchCriteria)


### Example

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

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

let depositTransactionSearchCriteria: DepositTransactionSearchCriteria; //The criteria to use to search deposit transactions.
let offset: number; //Pagination, index to start searching at when retrieving elements, used in combination with limit to paginate results (optional) (default to undefined)
let limit: number; //Pagination, the number of elements to retrieve, used in combination with offset to paginate results (optional) (default to undefined)
let paginationDetails: 'ON' | 'OFF'; //Flag specifying whether the pagination  details should be provided in response headers. Please note that by default it is disabled (OFF), in order to improve the performance of the APIs (optional) (default to 'OFF')
let cursor: string; //Pagination, cursor to start searching at when retrieving elements, used in combination with limit to paginate results (optional) (default to undefined)
let detailsLevel: 'BASIC' | 'FULL'; //The level of details to return: `FULL` means the full details of the object will be returned (custom field values, address, contact info, or any other related objects) and `BASIC` will return only the first level elements of the object. (optional) (default to undefined)

const { status, data } = await apiInstance.search(
    depositTransactionSearchCriteria,
    offset,
    limit,
    paginationDetails,
    cursor,
    detailsLevel
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositTransactionSearchCriteria** | **DepositTransactionSearchCriteria**| The criteria to use to search deposit transactions. | |
| **offset** | [**number**] | Pagination, index to start searching at when retrieving elements, used in combination with limit to paginate results | (optional) defaults to undefined|
| **limit** | [**number**] | Pagination, the number of elements to retrieve, used in combination with offset to paginate results | (optional) defaults to undefined|
| **paginationDetails** | [**&#39;ON&#39; | &#39;OFF&#39;**]**Array<&#39;ON&#39; &#124; &#39;OFF&#39;>** | Flag specifying whether the pagination  details should be provided in response headers. Please note that by default it is disabled (OFF), in order to improve the performance of the APIs | (optional) defaults to 'OFF'|
| **cursor** | [**string**] | Pagination, cursor to start searching at when retrieving elements, used in combination with limit to paginate results | (optional) defaults to undefined|
| **detailsLevel** | [**&#39;BASIC&#39; | &#39;FULL&#39;**]**Array<&#39;BASIC&#39; &#124; &#39;FULL&#39;>** | The level of details to return: &#x60;FULL&#x60; means the full details of the object will be returned (custom field values, address, contact info, or any other related objects) and &#x60;BASIC&#x60; will return only the first level elements of the object. | (optional) defaults to undefined|


### Return type

**Array<DepositTransaction>**

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | The results of a deposit transaction search. |  * Items-Limit - Pagination details, the requested page size <br>  * Items-Next-Cursor - The next cursor to be used by the subsequent calls <br>  * Items-Offset - Pagination details, the index of the first returned item <br>  * Items-Total - Pagination details, the total available items <br>  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |

[[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)