# DepositAccountsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**_delete**](#_delete) | **DELETE** /deposits/{depositAccountId} | Delete inactive deposit account|
|[**applyInterest**](#applyinterest) | **POST** /deposits/{depositAccountId}:applyInterest | Represents information to apply accrued interest.|
|[**bulkUpdateAccounts**](#bulkupdateaccounts) | **PUT** /deposits/bulkUpdates | Bulk update deposit accounts|
|[**changeInterestRate**](#changeinterestrate) | **POST** /deposits/{depositAccountId}:changeInterestRate | Change deposit account interest rate|
|[**changeState**](#changestate) | **POST** /deposits/{depositAccountId}:changeState | Represents the information to post an action, such as approving a deposit account.|
|[**changeWithholdingTax**](#changewithholdingtax) | **POST** /deposits/{depositAccountId}:changeWithholdingTax | Change deposit account withholding tax rate|
|[**create**](#create) | **POST** /deposits | Create deposit account|
|[**createAuthorizationHold**](#createauthorizationhold) | **POST** /deposits/{depositAccountId}/authorizationholds | Create an authorization hold corresponding to a given account|
|[**createBlockFund**](#createblockfund) | **POST** /deposits/{depositAccountId}/blocks | Create a block fund for the account|
|[**createCard**](#createcard) | **POST** /deposits/{depositAccountId}/cards | Represents the information needed to create and associate a new card to an account.|
|[**deleteCard**](#deletecard) | **DELETE** /deposits/{depositAccountId}/cards/{cardReferenceToken} | Represents the information needed to delete a card associated to an account using its reference token.|
|[**getAll**](#getall) | **GET** /deposits | Get deposit accounts|
|[**getAllAuthorizationHolds**](#getallauthorizationholds) | **GET** /deposits/{depositAccountId}/authorizationholds | Get authorization holds related to a deposit account, ordered from newest to oldest by creation date|
|[**getAllBlocks**](#getallblocks) | **GET** /deposits/{depositAccountId}/blocks | Get all block funds for a deposit account|
|[**getAllCards**](#getallcards) | **GET** /deposits/{depositAccountId}/cards | Get cards associated with an account|
|[**getAuthorizationHoldById**](#getauthorizationholdbyid) | **GET** /deposits/{depositAccountId}/authorizationholds/{authorizationHoldExternalReferenceId} | Get account authorization hold|
|[**getById**](#getbyid) | **GET** /deposits/{depositAccountId} | Get deposit account|
|[**getFundedLoans**](#getfundedloans) | **GET** /deposits/{depositAccountId}/funding | Get all loan accounts funded by the deposit account with the given ID or encoded key|
|[**getWithholdingTaxHistory**](#getwithholdingtaxhistory) | **GET** /deposits/{depositAccountId}/withholdingtaxes | Get deposit account withholding tax history|
|[**patch**](#patch) | **PATCH** /deposits/{depositAccountId} | Partially update deposit account|
|[**patchBlockFund**](#patchblockfund) | **PATCH** /deposits/{depositAccountId}/blocks/{externalReferenceId} | Updates the amount of an existing blocked fund on a deposit account. If the new amount equals the seized amount the block fund will transition to a seized state.|
|[**reopen**](#reopen) | **POST** /deposits/{depositAccountId}:reopen | Reopen a deposit account|
|[**reverseAuthorizationHold**](#reverseauthorizationhold) | **DELETE** /deposits/{depositAccountId}/authorizationholds/{authorizationHoldExternalReferenceId} | Reverse account authorization hold|
|[**search**](#search) | **POST** /deposits:search | Search deposit accounts|
|[**startMaturity**](#startmaturity) | **POST** /deposits/{depositAccountId}:startMaturity | Represents the information to post an action, such as approving a deposit account.|
|[**transferOwnership**](#transferownership) | **POST** /deposits/{depositAccountId}:transferOwnership | Transfer the account ownership from current account holder to a new one (client/group).|
|[**unblockFund**](#unblockfund) | **DELETE** /deposits/{depositAccountId}/blocks/{externalReferenceId} | Unblock a previously blocked fund for a deposit account|
|[**undoMaturity**](#undomaturity) | **POST** /deposits/{depositAccountId}:undoMaturity | Represents the action to undo the maturity period for the specified deposit account.|
|[**update**](#update) | **PUT** /deposits/{depositAccountId} | Update deposit account|

# **_delete**
> _delete()


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)

const { status, data } = await apiInstance._delete(
    depositAccountId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | defaults to undefined|


### Return type

void (empty response body)

### 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 |
|-------------|-------------|------------------|
|**204** | The deposit account has been deleted. |  -  |
|**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. |  -  |

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

# **applyInterest**
> applyInterest(applyInterestInput)


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit to apply interest to. (default to undefined)
let applyInterestInput: ApplyInterestInput; //Represents information to apply accrued interest.
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.applyInterest(
    depositAccountId,
    applyInterestInput,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **applyInterestInput** | **ApplyInterestInput**| Represents information to apply accrued interest. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit to apply interest to. | 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

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. |  -  |
|**204** | Interest has been applied. |  -  |
|**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)

# **bulkUpdateAccounts**
> BulkDepositAccountUpdateResponse bulkUpdateAccounts(bulkDepositAccountUpdateRequest)


### Example

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

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

let bulkDepositAccountUpdateRequest: BulkDepositAccountUpdateRequest; //Represents the information to bulk update deposit accounts.
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.bulkUpdateAccounts(
    bulkDepositAccountUpdateRequest,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **bulkDepositAccountUpdateRequest** | **BulkDepositAccountUpdateRequest**| Represents the information to bulk update deposit accounts. | |
| **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

**BulkDepositAccountUpdateResponse**

### 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 bulk update has been completed. |  -  |
|**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)

# **changeInterestRate**
> changeInterestRate(changeInterestRateAction)


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)
let changeInterestRateAction: ChangeInterestRateAction; //Represents the information needed to change the interest rate.
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.changeInterestRate(
    depositAccountId,
    changeInterestRateAction,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **changeInterestRateAction** | **ChangeInterestRateAction**| Represents the information needed to change the interest rate. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | 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

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. |  -  |
|**204** | The interest rate change has been applied to the deposit account. |  -  |
|**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. |  -  |

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

# **changeState**
> DepositAccount changeState(depositAccountAction)


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)
let depositAccountAction: DepositAccountAction; //Represents the action details for 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.changeState(
    depositAccountId,
    depositAccountAction,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccountAction** | **DepositAccountAction**| Represents the action details for a deposit account. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | 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

**DepositAccount**

### 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 account action has been posted. |  -  |
|**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. |  -  |

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

# **changeWithholdingTax**
> changeWithholdingTax(changeWithholdingTaxAction)


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)
let changeWithholdingTaxAction: ChangeWithholdingTaxAction; //Represents the information needed to change the withholding tax rate.
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.changeWithholdingTax(
    depositAccountId,
    changeWithholdingTaxAction,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **changeWithholdingTaxAction** | **ChangeWithholdingTaxAction**| Represents the information needed to change the withholding tax rate. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | 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

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. |  -  |
|**204** | The withholding tax rate change has been applied to this deposit account. |  -  |
|**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)

# **create**
> DepositAccount create(depositAccount)


### Example

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

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

let depositAccount: DepositAccount; //Represents the information to create 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.create(
    depositAccount,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccount** | **DepositAccount**| Represents the information to create a deposit account. | |
| **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

**DepositAccount**

### 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 account has been created. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**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)

# **createAuthorizationHold**
> AccountAuthorizationHold createAuthorizationHold(accountAuthorizationHold)


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)
let accountAuthorizationHold: AccountAuthorizationHold; //The authorization hold to be created.
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.createAuthorizationHold(
    depositAccountId,
    accountAuthorizationHold,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **accountAuthorizationHold** | **AccountAuthorizationHold**| The authorization hold to be created. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | 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

**AccountAuthorizationHold**

### 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 account authorization hold was successfully 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. |  -  |

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

# **createBlockFund**
> BlockFund createBlockFund(blockFund)


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)
let blockFund: BlockFund; //The block fund to be created.
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.createBlockFund(
    depositAccountId,
    blockFund,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **blockFund** | **BlockFund**| The block fund to be created. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | 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

**BlockFund**

### 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 block fund was 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. |  -  |

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

# **createCard**
> createCard(card)


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)
let card: Card; //The card to be created.
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.createCard(
    depositAccountId,
    card,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **card** | **Card**| The card to be created. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | 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

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. |  -  |
|**201** | The card was 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. |  -  |

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

# **deleteCard**
> deleteCard()


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)
let cardReferenceToken: string; //The reference token of the card to be returned. (default to undefined)

const { status, data } = await apiInstance.deleteCard(
    depositAccountId,
    cardReferenceToken
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | defaults to undefined|
| **cardReferenceToken** | [**string**] | The reference token of the card to be returned. | defaults to undefined|


### Return type

void (empty response body)

### 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 |
|-------------|-------------|------------------|
|**204** | The card was deleted. |  -  |
|**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<DepositAccount> getAll()


### Example

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

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

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)
let creditOfficerUsername: string; //The username of the credit officer assigned to the deposit accounts. (optional) (default to undefined)
let branchId: string; //The ID or encoded key of the branch assigned to the deposit accounts. (optional) (default to undefined)
let centreId: string; //The ID or encoded key of the centre assigned to the deposit accounts. (optional) (default to undefined)
let accountState: 'PENDING_APPROVAL' | 'APPROVED' | 'ACTIVE' | 'ACTIVE_IN_ARREARS' | 'MATURED' | 'LOCKED' | 'DORMANT' | 'CLOSED' | 'CLOSED_WRITTEN_OFF' | 'WITHDRAWN' | 'CLOSED_REJECTED'; //The state to use to filter deposit accounts by. (optional) (default to undefined)
let accountHolderType: 'CLIENT' | 'GROUP'; //The account holder type. (optional) (default to undefined)
let accountHolderId: string; //The ID of the account holder. (optional) (default to undefined)

const { status, data } = await apiInstance.getAll(
    offset,
    limit,
    paginationDetails,
    detailsLevel,
    creditOfficerUsername,
    branchId,
    centreId,
    accountState,
    accountHolderType,
    accountHolderId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **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|
| **creditOfficerUsername** | [**string**] | The username of the credit officer assigned to the deposit accounts. | (optional) defaults to undefined|
| **branchId** | [**string**] | The ID or encoded key of the branch assigned to the deposit accounts. | (optional) defaults to undefined|
| **centreId** | [**string**] | The ID or encoded key of the centre assigned to the deposit accounts. | (optional) defaults to undefined|
| **accountState** | [**&#39;PENDING_APPROVAL&#39; | &#39;APPROVED&#39; | &#39;ACTIVE&#39; | &#39;ACTIVE_IN_ARREARS&#39; | &#39;MATURED&#39; | &#39;LOCKED&#39; | &#39;DORMANT&#39; | &#39;CLOSED&#39; | &#39;CLOSED_WRITTEN_OFF&#39; | &#39;WITHDRAWN&#39; | &#39;CLOSED_REJECTED&#39;**]**Array<&#39;PENDING_APPROVAL&#39; &#124; &#39;APPROVED&#39; &#124; &#39;ACTIVE&#39; &#124; &#39;ACTIVE_IN_ARREARS&#39; &#124; &#39;MATURED&#39; &#124; &#39;LOCKED&#39; &#124; &#39;DORMANT&#39; &#124; &#39;CLOSED&#39; &#124; &#39;CLOSED_WRITTEN_OFF&#39; &#124; &#39;WITHDRAWN&#39; &#124; &#39;CLOSED_REJECTED&#39;>** | The state to use to filter deposit accounts by. | (optional) defaults to undefined|
| **accountHolderType** | [**&#39;CLIENT&#39; | &#39;GROUP&#39;**]**Array<&#39;CLIENT&#39; &#124; &#39;GROUP&#39;>** | The account holder type. | (optional) defaults to undefined|
| **accountHolderId** | [**string**] | The ID of the account holder. | (optional) defaults to undefined|


### Return type

**Array<DepositAccount>**

### 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** | Deposit accounts list 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 |  -  |
|**404** | Currency 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)

# **getAllAuthorizationHolds**
> Array<DepositAuthorizationHold> getAllAuthorizationHolds()


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (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 status: 'PENDING' | 'REVERSED' | 'SETTLED' | 'EXPIRED'; //The status of the authorization holds to filter on (optional) (default to undefined)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | 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'|
| **status** | [**&#39;PENDING&#39; | &#39;REVERSED&#39; | &#39;SETTLED&#39; | &#39;EXPIRED&#39;**]**Array<&#39;PENDING&#39; &#124; &#39;REVERSED&#39; &#124; &#39;SETTLED&#39; &#124; &#39;EXPIRED&#39;>** | The status of the authorization holds to filter on | (optional) defaults to undefined|


### Return type

**Array<DepositAuthorizationHold>**

### 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 authorization holds 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 |  -  |
|**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)

# **getAllBlocks**
> Array<BlockFund> getAllBlocks()


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (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 state: 'PENDING' | 'SEIZED' | 'REMOVED' | 'PARTIALLY_SEIZED'; //The state of the block fund to filter on (optional) (default to undefined)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | 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'|
| **state** | [**&#39;PENDING&#39; | &#39;SEIZED&#39; | &#39;REMOVED&#39; | &#39;PARTIALLY_SEIZED&#39;**]**Array<&#39;PENDING&#39; &#124; &#39;SEIZED&#39; &#124; &#39;REMOVED&#39; &#124; &#39;PARTIALLY_SEIZED&#39;>** | The state of the block fund to filter on | (optional) defaults to undefined|


### Return type

**Array<BlockFund>**

### 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 block funds have been returned. |  -  |
|**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)

# **getAllCards**
> Array<Card> getAllCards()


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)

const { status, data } = await apiInstance.getAllCards(
    depositAccountId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | defaults to undefined|


### Return type

**Array<Card>**

### 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 cards attached to the account was returned. |  -  |
|**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)

# **getAuthorizationHoldById**
> AccountAuthorizationHold getAuthorizationHoldById()


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)
let authorizationHoldExternalReferenceId: string; //The ID used to reference the authorization hold. (default to undefined)

const { status, data } = await apiInstance.getAuthorizationHoldById(
    depositAccountId,
    authorizationHoldExternalReferenceId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | defaults to undefined|
| **authorizationHoldExternalReferenceId** | [**string**] | The ID used to reference the authorization hold. | defaults to undefined|


### Return type

**AccountAuthorizationHold**

### 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 authorization hold has been returned. |  -  |
|**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)

# **getById**
> DepositAccount getById()


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (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(
    depositAccountId,
    detailsLevel
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | 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

**DepositAccount**

### 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 account has been returned. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | Deposit Account or Interest Availability does not exist. |  -  |

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

# **getFundedLoans**
> Array<LoanAccount> getFundedLoans()


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)

const { status, data } = await apiInstance.getFundedLoans(
    depositAccountId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | defaults to undefined|


### Return type

**Array<LoanAccount>**

### 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 funded loan accounts has been returned. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | Deposit Account or Interest Availability does not exist. |  -  |

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

# **getWithholdingTaxHistory**
> Array<AccountTax> getWithholdingTaxHistory()


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)
let from: string; //The start date to get withholding tax history. (optional) (default to undefined)
let to: string; //The end date to to get withholding tax history. (optional) (default to undefined)

const { status, data } = await apiInstance.getWithholdingTaxHistory(
    depositAccountId,
    from,
    to
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | defaults to undefined|
| **from** | [**string**] | The start date to get withholding tax history. | (optional) defaults to undefined|
| **to** | [**string**] | The end date to to get withholding tax history. | (optional) defaults to undefined|


### Return type

**Array<AccountTax>**

### 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 withholding tax history for the given period. |  -  |
|**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)

# **patch**
> patch(patchOperation)


### Example

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

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

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

const { status, data } = await apiInstance.patch(
    depositAccountId,
    patchOperation
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **patchOperation** | **Array<PatchOperation>**| Patch operations to be applied to a resource. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | 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 account has been updated. |  -  |
|**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. |  -  |

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

# **patchBlockFund**
> patchBlockFund(patchOperation)


### Example

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

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

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

const { status, data } = await apiInstance.patchBlockFund(
    depositAccountId,
    externalReferenceId,
    patchOperation
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **patchOperation** | **Array<PatchOperation>**| Patch operations to be applied to a resource. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | defaults to undefined|
| **externalReferenceId** | [**string**] | The external reference ID of the 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 block amount was updated. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | The block fund 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)

# **reopen**
> DepositAccount reopen(reopenDepositAction)


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit to be reopened. (default to undefined)
let reopenDepositAction: ReopenDepositAction; //Represents the information needed to reopen 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.reopen(
    depositAccountId,
    reopenDepositAction,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **reopenDepositAction** | **ReopenDepositAction**| Represents the information needed to reopen a deposit account. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit to be reopened. | 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

**DepositAccount**

### 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** | Deposit account reopened. |  -  |
|**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. |  -  |

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

# **reverseAuthorizationHold**
> reverseAuthorizationHold()


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)
let authorizationHoldExternalReferenceId: string; //The ID used to reference the authorization hold. (default to undefined)

const { status, data } = await apiInstance.reverseAuthorizationHold(
    depositAccountId,
    authorizationHoldExternalReferenceId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | defaults to undefined|
| **authorizationHoldExternalReferenceId** | [**string**] | The ID used to reference the authorization hold. | defaults to undefined|


### Return type

void (empty response body)

### 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 |
|-------------|-------------|------------------|
|**204** | The account authorization hold was successfully reversed. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | The account or authorization hold 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)

# **search**
> Array<DepositAccount> search(depositAccountSearchCriteria)


### Example

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

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

let depositAccountSearchCriteria: DepositAccountSearchCriteria; //The criteria to be used to search the deposit accounts.
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(
    depositAccountSearchCriteria,
    offset,
    limit,
    paginationDetails,
    cursor,
    detailsLevel
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccountSearchCriteria** | **DepositAccountSearchCriteria**| The criteria to be used to search the deposit accounts. | |
| **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<DepositAccount>**

### 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 deposit account search results have been returned. |  * 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)

# **startMaturity**
> DepositAccount startMaturity(startMaturityAction)


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)
let startMaturityAction: StartMaturityAction; //Represents the action to start the maturity period for 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.startMaturity(
    depositAccountId,
    startMaturityAction,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **startMaturityAction** | **StartMaturityAction**| Represents the action to start the maturity period for a deposit account. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | 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

**DepositAccount**

### 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 start maturity action has been posted. |  -  |
|**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. |  -  |

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

# **transferOwnership**
> transferOwnership(transferOwnershipAction)


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account to have it\'s ownership transferred. (default to undefined)
let transferOwnershipAction: TransferOwnershipAction; //The information needed to transfer the account ownership from current account holder to a new one.
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.transferOwnership(
    depositAccountId,
    transferOwnershipAction,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **transferOwnershipAction** | **TransferOwnershipAction**| The information needed to transfer the account ownership from current account holder to a new one. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account to have it\&#39;s ownership transferred. | 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

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. |  -  |
|**204** | The account ownership has been transferred to the new account holder. |  -  |
|**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. |  -  |

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

# **unblockFund**
> unblockFund()


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)
let externalReferenceId: string; // (default to undefined)

const { status, data } = await apiInstance.unblockFund(
    depositAccountId,
    externalReferenceId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | defaults to undefined|
| **externalReferenceId** | [**string**] |  | defaults to undefined|


### Return type

void (empty response body)

### 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 |
|-------------|-------------|------------------|
|**204** | The block fund has been removed. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | The block fund 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)

# **undoMaturity**
> undoMaturity()


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)
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)
let undoMaturityAction: UndoMaturityAction; //Represents the action to undo the maturity period for the specified deposit account. (optional)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **undoMaturityAction** | **UndoMaturityAction**| Represents the action to undo the maturity period for the specified deposit account. | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | 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

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. |  -  |
|**204** | The undo maturity action has been posted. |  -  |
|**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. |  -  |

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

# **update**
> DepositAccount update()


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)
let depositAccount: DepositAccount; // (optional)

const { status, data } = await apiInstance.update(
    depositAccountId,
    depositAccount
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccount** | **DepositAccount**|  | |
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | defaults to undefined|


### Return type

**DepositAccount**

### 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 deposit account has been updated. |  -  |
|**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. |  -  |

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