com.mambu.apisdk.services

Class SavingsService

java.lang.Object

com.mambu.apisdk.services.SavingsService

public class SavingsService
extends java.lang.Object

Service class which handles API operations like retrieval, creation or changing state of savings accounts. See full Mambu Savings API documentation at http://api.mambu.com/customer/portal/articles/1162285-savings-api?b_id=874

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CENTRE_ID

Constructor Summary

Constructors

Constructor and Description
SavingsService(MambuAPIService mambuAPIService) Create a new savings service

Method Summary

Modifier and Type	Method and Description
com.mambu.savings.shared.model.SavingsTransaction	applyFeeToSavingsAccount(java.lang.String accountId, java.util.List<com.mambu.loans.shared.model.CustomPredefinedFee> fees, java.lang.String notes) Apply Predefined Fee to to a savings account
com.mambu.savings.shared.model.SavingsTransaction	applyFeeToSavingsAccount(java.lang.String accountId, java.lang.String amount, java.lang.String notes) Apply Arbitrary FEE to a savings account
com.mambu.savings.shared.model.SavingsAccount	approveSavingsAccount(java.lang.String accountId, java.lang.String notes) Approve Savings account
com.mambu.savings.shared.model.SavingsAccount	closeSavingsAccount(java.lang.String accountId, APIData.CLOSER_TYPE closerType, java.lang.String notes) Close Savings account specifying the type of closer (withdraw, reject or close) Note: available since Mambu 3.4 See MBU-4581 and MBU-10976 for details.
com.mambu.api.server.handler.savings.model.JSONSavingsAccount	createSavingsAccount(com.mambu.api.server.handler.savings.model.JSONSavingsAccount jsonSavingsAccount) Create new SavingsAccount using JSONSavingsAccount object and sending it via the JSON API.
com.mambu.savings.shared.model.SavingsAccount	createSavingsAccount(com.mambu.savings.shared.model.SavingsAccount savingsAccount) Convenience method to create new SavingsAccount using SavingsAccount object.
boolean	deleteSavingsAccount(java.lang.String accountId) Delete Savings Account by its Id Note: available since Mambu 3.4 See MBU-4581 for details.
com.mambu.savings.shared.model.SavingsTransaction	executeJSONTransactionRequest(java.lang.String accountId, com.mambu.savings.shared.model.SavingsTransactionType transactionType, com.mambu.api.server.handler.loan.model.JSONTransactionRequest transactionRequest) Convenience method to execute Savings Account transaction by providing JSONTransactionRequest
java.util.List<com.mambu.loans.shared.model.LoanAccount>	getFundedLoanAccounts(java.lang.String savingsId) Get all loan accounts funded by a deposit investor account
com.mambu.savings.shared.model.SavingsAccount	getSavingsAccount(java.lang.String accountId) Get a savings account by its id
com.mambu.savings.shared.model.SavingsAccount	getSavingsAccountDetails(java.lang.String accountId) Get a savings account with full details by its id
java.util.List<com.mambu.savings.shared.model.SavingsAccount>	getSavingsAccounts(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints, java.lang.String offset, java.lang.String limit) Get savings accounts by specifying filter constraints.
java.util.List<com.mambu.savings.shared.model.SavingsAccount>	getSavingsAccountsByBranchCentreOfficerState(java.lang.String branchId, java.lang.String centreId, java.lang.String creditOfficerUserName, java.lang.String accountState, java.lang.String offset, java.lang.String limit) Get the Savings accounts by branch id, centreId, credit officer, accountState
java.util.List<com.mambu.savings.shared.model.SavingsAccount>	getSavingsAccountsByBranchOfficerState(java.lang.String branchId, java.lang.String creditOfficerUserName, java.lang.String accountState, java.lang.String offset, java.lang.String limit) Get the Savings accounts by branch id, credit officer, accountState
java.util.List<com.mambu.savings.shared.model.SavingsAccount>	getSavingsAccountsForClient(java.lang.String clientId) Get all the savings accounts for a given client
java.util.List<com.mambu.savings.shared.model.SavingsAccount>	getSavingsAccountsForGroup(java.lang.String groupId) Get all the savings accounts for a given group
java.util.List<com.mambu.savings.shared.model.SavingsTransaction>	getSavingsAccountTransactions(java.lang.String accountId, java.lang.String offset, java.lang.String limit) Get Savings Account Transactions by an account id and offset and limit
com.mambu.savings.shared.model.SavingsProduct	getSavingsProduct(java.lang.String productId) Get a Savings Product by Product id
java.util.List<com.mambu.savings.shared.model.SavingsProduct>	getSavingsProducts(java.lang.String offset, java.lang.String limit) Get a list of Savings Products
java.util.List<com.mambu.savings.shared.model.SavingsTransaction>	getSavingsTransactions(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints, java.lang.String offset, java.lang.String limit) Deprecated.
java.util.List<com.mambu.savings.shared.model.SavingsTransaction>	getSavingsTransactionsWithBasicDetails(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints, java.lang.String offset, java.lang.String limit) Get savings transactions by specifying filter constraints with all the details (no custom fields)
java.util.List<com.mambu.savings.shared.model.SavingsTransaction>	getSavingsTransactionsWithFullDetails(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints, java.lang.String offset, java.lang.String limit) Get savings transactions by specifying filter constraints with all the details (custom fields included)
com.mambu.savings.shared.model.SavingsTransaction	makeDeposit(java.lang.String accountId, com.mambu.core.shared.model.Money amount, java.util.Date date, com.mambu.accounts.shared.model.TransactionDetails transactionDetails, java.util.List<com.mambu.core.shared.model.CustomFieldValue> customInformation, java.lang.String notes) Make a deposit to an account.
com.mambu.savings.shared.model.SavingsTransaction	makeTransfer(java.lang.String fromAccountId, java.lang.String destinationAccountKey, com.mambu.accounts.shared.model.Account.Type destinationAccountType, java.lang.String amount, java.lang.String notes) Make transfer from an account
com.mambu.savings.shared.model.SavingsTransaction	makeWithdrawal(java.lang.String accountId, com.mambu.core.shared.model.Money amount, java.util.Date date, com.mambu.accounts.shared.model.TransactionDetails transactionDetails, java.util.List<com.mambu.core.shared.model.CustomFieldValue> customInformation, java.lang.String notes) Make a withdrawal from an account.
boolean	patchSavingsAccount(com.mambu.savings.shared.model.SavingsAccount savings) Update savings terms for an existent savings account This API allows updating SavingsAccount terms only.
com.mambu.savings.shared.model.SavingsTransaction	reverseSavingsTransaction(com.mambu.savings.shared.model.SavingsTransaction originalTransaction, java.lang.String notes) Reverse transaction for a savings account by providing the original savings transaction
com.mambu.savings.shared.model.SavingsTransaction	reverseSavingsTransaction(java.lang.String accountId, com.mambu.savings.shared.model.SavingsTransactionType originalTransactionType, java.lang.String originalTransactionId, java.lang.String notes) Reverse savings transactions for a savings account
com.mambu.savings.shared.model.SavingsAccount	startMaturity(java.lang.String accountId, java.util.Date date, java.lang.String notes) Starts maturity for a saving account.
com.mambu.savings.shared.model.SavingsAccount	undoApproveSavingsAccount(java.lang.String accountId, java.lang.String notes) Undo Approve for a savings account
com.mambu.savings.shared.model.SavingsAccount	undoCloseSavingsAccount(com.mambu.savings.shared.model.SavingsAccount savingsAccount, java.lang.String notes) Undo Close Savings account.
com.mambu.api.server.handler.savings.model.JSONSavingsAccount	updateSavingsAccount(com.mambu.api.server.handler.savings.model.JSONSavingsAccount jsonSavingsAccount) Update an existent SavingsAccount using JSONSavingsAccount object and sending it via the JSON API.
com.mambu.savings.shared.model.SavingsAccount	updateSavingsAccount(com.mambu.savings.shared.model.SavingsAccount savingsAccount) Convenience method to Update an existent SavingsAccount.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CENTRE_ID

public static final java.lang.String CENTRE_ID

See Also:

Constant Field Values

Constructor Detail

SavingsService

@Inject
public SavingsService(MambuAPIService mambuAPIService)

Create a new savings service

Parameters:

mambuAPIService - the service responsible with the connection to the server

Method Detail

getSavingsAccount

public com.mambu.savings.shared.model.SavingsAccount getSavingsAccount(java.lang.String accountId)
                                                                throws MambuApiException

Get a savings account by its id

Parameters:

accountId - the id of the account

Returns:

the savings account

Throws:

MambuApiException

getSavingsAccountDetails

public com.mambu.savings.shared.model.SavingsAccount getSavingsAccountDetails(java.lang.String accountId)
                                                                       throws MambuApiException

Get a savings account with full details by its id

Parameters:

accountId - the id of the account

Returns:

the savings account

Throws:

MambuApiException

getSavingsAccountsForClient

public java.util.List<com.mambu.savings.shared.model.SavingsAccount> getSavingsAccountsForClient(java.lang.String clientId)
                                                                                          throws MambuApiException

Get all the savings accounts for a given client

Parameters:

clientId - the id of the client

Returns:

the client's list of savings accounts

Throws:

MambuApiException

approveSavingsAccount

public com.mambu.savings.shared.model.SavingsAccount approveSavingsAccount(java.lang.String accountId,
                                                                           java.lang.String notes)
                                                                    throws MambuApiException

Approve Savings account

Parameters:

accountId - the id of the account

Returns:

the approved SavingsAccount from Mambu Note: the returned account object doesn't contain custom fields.

Throws:

MambuApiException

undoApproveSavingsAccount

public com.mambu.savings.shared.model.SavingsAccount undoApproveSavingsAccount(java.lang.String accountId,
                                                                               java.lang.String notes)
                                                                        throws MambuApiException

Undo Approve for a savings account

Parameters:

accountId - the id of the savings account

Returns:

savingsAccount Note: The account object in the response doesn't contain custom fields

Throws:

MambuApiException

getSavingsAccountTransactions

public java.util.List<com.mambu.savings.shared.model.SavingsTransaction> getSavingsAccountTransactions(java.lang.String accountId,
                                                                                                       java.lang.String offset,
                                                                                                       java.lang.String limit)
                                                                                                throws MambuApiException

Get Savings Account Transactions by an account id and offset and limit

Parameters:

accountId - the id of the account

offset - first transaction number

limit - last transaction number Note: if offset and limit both equal null, all transactions are returned (Note: transaction are sorted by date)

Returns:

the list of savings transactions

Throws:

MambuApiException

getSavingsTransactions

@Deprecated
public java.util.List<com.mambu.savings.shared.model.SavingsTransaction> getSavingsTransactions(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints,
                                                                                                            java.lang.String offset,
                                                                                                            java.lang.String limit)
                                                                                                     throws MambuApiException

Deprecated.

Get savings transactions by specifying filter constraints Note: This method is deprecated, you may use the getSavingsTransactionsWithFullDetails in order to obtain savings transactions with full details (custom fields included) or getSavingsAccountsWithBasicDetails to obtain the savings transactions in basic details level.

Parameters:

filterConstraints - filter constraints. Must not be null

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

list of savings transactions matching filter constraints

Throws:

MambuApiException

getSavingsTransactionsWithFullDetails

public java.util.List<com.mambu.savings.shared.model.SavingsTransaction> getSavingsTransactionsWithFullDetails(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints,
                                                                                                               java.lang.String offset,
                                                                                                               java.lang.String limit)
                                                                                                        throws MambuApiException

Get savings transactions by specifying filter constraints with all the details (custom fields included)

Parameters:

filterConstraints - filter constraints. Must not be null

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

list of savings transactions matching filter constraints

Throws:

MambuApiException

getSavingsTransactionsWithBasicDetails

public java.util.List<com.mambu.savings.shared.model.SavingsTransaction> getSavingsTransactionsWithBasicDetails(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints,
                                                                                                                java.lang.String offset,
                                                                                                                java.lang.String limit)
                                                                                                         throws MambuApiException

Get savings transactions by specifying filter constraints with all the details (no custom fields)

Parameters:

filterConstraints - filter constraints. Must not be null

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

list of savings transactions matching filter constraints

Throws:

MambuApiException

makeWithdrawal

public com.mambu.savings.shared.model.SavingsTransaction makeWithdrawal(java.lang.String accountId,
                                                                        com.mambu.core.shared.model.Money amount,
                                                                        java.util.Date date,
                                                                        com.mambu.accounts.shared.model.TransactionDetails transactionDetails,
                                                                        java.util.List<com.mambu.core.shared.model.CustomFieldValue> customInformation,
                                                                        java.lang.String notes)
                                                                 throws MambuApiException

Make a withdrawal from an account.

Parameters:

accountId - account ID or encoded key. Must not be null

amount - transaction amount

date - transaction date

transactionDetails - transaction details

customInformation - transaction custom fields

notes - transaction notes

Returns:

Savings Transaction

Throws:

MambuApiException

makeDeposit

public com.mambu.savings.shared.model.SavingsTransaction makeDeposit(java.lang.String accountId,
                                                                     com.mambu.core.shared.model.Money amount,
                                                                     java.util.Date date,
                                                                     com.mambu.accounts.shared.model.TransactionDetails transactionDetails,
                                                                     java.util.List<com.mambu.core.shared.model.CustomFieldValue> customInformation,
                                                                     java.lang.String notes)
                                                              throws MambuApiException

Make a deposit to an account.

Parameters:

accountId - account ID or encoded key. Must not be null

amount - transaction amount

date - transaction date

transactionDetails - transaction details

customInformation - transaction custom fields

notes - transaction notes

Returns:

Savings Transaction

Throws:

MambuApiException

makeTransfer

public com.mambu.savings.shared.model.SavingsTransaction makeTransfer(java.lang.String fromAccountId,
                                                                      java.lang.String destinationAccountKey,
                                                                      com.mambu.accounts.shared.model.Account.Type destinationAccountType,
                                                                      java.lang.String amount,
                                                                      java.lang.String notes)
                                                               throws MambuApiException

Make transfer from an account

Parameters:

fromAccountId - the id of the account the amount to transfer from

destinationAccountKey - the id of the account to transfer to

destinationAccountType - type of the account (Type.Loan or Type.Savings)

amount - amount to transfer

notes -

Returns:

Savings Transaction

Throws:

MambuApiException

applyFeeToSavingsAccount

public com.mambu.savings.shared.model.SavingsTransaction applyFeeToSavingsAccount(java.lang.String accountId,
                                                                                  java.lang.String amount,
                                                                                  java.lang.String notes)
                                                                           throws MambuApiException

Apply Arbitrary FEE to a savings account

Parameters:

accountId - the id of the account

amount - fee amount

notes - transaction notes

Returns:

Savings Transaction

Throws:

MambuApiException

applyFeeToSavingsAccount

public com.mambu.savings.shared.model.SavingsTransaction applyFeeToSavingsAccount(java.lang.String accountId,
                                                                                  java.util.List<com.mambu.loans.shared.model.CustomPredefinedFee> fees,
                                                                                  java.lang.String notes)
                                                                           throws MambuApiException

Apply Predefined Fee to to a savings account

Parameters:

accountId - the id or the encoded key of the account. Must not be null

fees - fees. Only Manual Predefined Fees are currently supported. Must not be null. Must contain exactly one fee. Note: Once MBU-12865 is implemented this method will support both predefined fees and arbitrary fees and the (@link #applyFeeToLoanAccount(String, String, String, String)} method used for arbitrary fees can be deprecated

notes - transaction notes

Returns:

Savings Transaction

Throws:

MambuApiException

executeJSONTransactionRequest

public com.mambu.savings.shared.model.SavingsTransaction executeJSONTransactionRequest(java.lang.String accountId,
                                                                                       com.mambu.savings.shared.model.SavingsTransactionType transactionType,
                                                                                       com.mambu.api.server.handler.loan.model.JSONTransactionRequest transactionRequest)
                                                                                throws MambuApiException

Convenience method to execute Savings Account transaction by providing JSONTransactionRequest

Parameters:

accountId - account id or encoded key. Must not be null

transactionType - savings transaction type. Must not be null. Supported types are: FEE_APPLIED, DEPOSIT and WITHDRAWAL

transactionRequest - JSON transaction request

Returns:

savings transaction

Throws:

MambuApiException

reverseSavingsTransaction

public com.mambu.savings.shared.model.SavingsTransaction reverseSavingsTransaction(java.lang.String accountId,
                                                                                   com.mambu.savings.shared.model.SavingsTransactionType originalTransactionType,
                                                                                   java.lang.String originalTransactionId,
                                                                                   java.lang.String notes)
                                                                            throws MambuApiException

Reverse savings transactions for a savings account

Parameters:

accountId - the id of the savings account. Mandatory

originalTransactionType - Original transaction type to be reversed. The following transaction types can be reversed: DEPOSIT, WITHDRAWAL, TRANSFER, FEE. Mandatory.

originalTransactionId - the id or the encodedKey of the transaction to be reversed. Mandatory

notes - transaction notes

Returns:

Savings Transaction

Throws:

MambuApiException

reverseSavingsTransaction

public com.mambu.savings.shared.model.SavingsTransaction reverseSavingsTransaction(com.mambu.savings.shared.model.SavingsTransaction originalTransaction,
                                                                                   java.lang.String notes)
                                                                            throws MambuApiException

Reverse transaction for a savings account by providing the original savings transaction

Parameters:

originalTransaction - The following transactions can be reversed: DEPOSIT, WITHDRAWAL and TRANSFER. Mandatory.

notes - transaction notes

Returns:

Savings Transaction

Throws:

MambuApiException

deleteSavingsAccount

public boolean deleteSavingsAccount(java.lang.String accountId)
                             throws MambuApiException

Delete Savings Account by its Id Note: available since Mambu 3.4 See MBU-4581 for details.

Parameters:

accountId -

Returns:

status

Throws:

MambuApiException

closeSavingsAccount

public com.mambu.savings.shared.model.SavingsAccount closeSavingsAccount(java.lang.String accountId,
                                                                         APIData.CLOSER_TYPE closerType,
                                                                         java.lang.String notes)
                                                                  throws MambuApiException

Close Savings account specifying the type of closer (withdraw, reject or close) Note: available since Mambu 3.4 See MBU-4581 and MBU-10976 for details.

Parameters:

accountId - the id of the account to withdraw. Must not be null

closerType - type of closer (withdraw, reject or close). Must not be null

notes - optional notes

Returns:

savings account

Throws:

MambuApiException

startMaturity

public com.mambu.savings.shared.model.SavingsAccount startMaturity(java.lang.String accountId,
                                                                   java.util.Date date,
                                                                   java.lang.String notes)
                                                            throws MambuApiException

Starts maturity for a saving account. (A transaction will be created and posted into Mambu in order to accomplish this) Example: POST "{"type":"START_MATURITY", "notes":"123", "date":"2017-01-12"}" /api/savings/{ID}/transactions/

Parameters:

accountId - The id of the saving account that maturity will be started for. Must not be NULL.

date - The date used to indicate when the maturity starts.

notes - Some notes that will be posted on the transaction that will be created for starting the maturity for the account.

Returns:

the SavingAccount the maturity was started for

Throws:

MambuApiException

undoCloseSavingsAccount

public com.mambu.savings.shared.model.SavingsAccount undoCloseSavingsAccount(com.mambu.savings.shared.model.SavingsAccount savingsAccount,
                                                                             java.lang.String notes)
                                                                      throws MambuApiException

Undo Close Savings account. Supports UNDO_REJECT, UNDO_WITHDRAWN, UNDO_CLOSE

Parameters:

savingsAccount - closed savings account. Must not be null and must be in one of the supported closed states.

notes - undo closer reason notes

Returns:

savings account

Throws:

MambuApiException

getSavingsAccountsForGroup

public java.util.List<com.mambu.savings.shared.model.SavingsAccount> getSavingsAccountsForGroup(java.lang.String groupId)
                                                                                         throws MambuApiException

Get all the savings accounts for a given group

Parameters:

groupId - the id of the group

Returns:

the group's list of Savings accounts

Throws:

MambuApiException

getSavingsAccountsByBranchCentreOfficerState

public java.util.List<com.mambu.savings.shared.model.SavingsAccount> getSavingsAccountsByBranchCentreOfficerState(java.lang.String branchId,
                                                                                                                  java.lang.String centreId,
                                                                                                                  java.lang.String creditOfficerUserName,
                                                                                                                  java.lang.String accountState,
                                                                                                                  java.lang.String offset,
                                                                                                                  java.lang.String limit)
                                                                                                           throws MambuApiException

Get the Savings accounts by branch id, centreId, credit officer, accountState

Parameters:

branchId - The ID of the branch to which the accounts are assigned to

centreId - The ID of the centre to which the loan accounts are assigned to. If both branchId and centreId are provided then this centre must be assigned to the branchId

creditOfficerUserName - the username of the credit officer to whom the accounts are assigned to

accountState - the state of the accounts to filter on (e.g: APPROVED)

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

the list of Savings accounts matching these parameters

Throws:

MambuApiException

getSavingsAccountsByBranchOfficerState

public java.util.List<com.mambu.savings.shared.model.SavingsAccount> getSavingsAccountsByBranchOfficerState(java.lang.String branchId,
                                                                                                            java.lang.String creditOfficerUserName,
                                                                                                            java.lang.String accountState,
                                                                                                            java.lang.String offset,
                                                                                                            java.lang.String limit)
                                                                                                     throws MambuApiException

Get the Savings accounts by branch id, credit officer, accountState

Parameters:

branchId - The ID of the branch to which the accounts are assigned to provided then this centre must be assigned to the branchId

creditOfficerUserName - the username of the credit officer to whom the accounts are assigned to

accountState - the state of the accounts to filter on (e.g: APPROVED)

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

the list of Savings accounts matching these parameters

Throws:

MambuApiException

getSavingsAccounts

public java.util.List<com.mambu.savings.shared.model.SavingsAccount> getSavingsAccounts(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints,
                                                                                        java.lang.String offset,
                                                                                        java.lang.String limit)
                                                                                 throws MambuApiException

Get savings accounts by specifying filter constraints. Also notice that the full details one may come with a performance hit so use it only if needed.

Parameters:

filterConstraints - filter constraints. Must not be null

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

list of savings accounts matching filter constraint

Throws:

MambuApiException

getSavingsProducts

public java.util.List<com.mambu.savings.shared.model.SavingsProduct> getSavingsProducts(java.lang.String offset,
                                                                                        java.lang.String limit)
                                                                                 throws MambuApiException

Get a list of Savings Products

Parameters:

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

the List of Savings Products

Throws:

MambuApiException

getSavingsProduct

public com.mambu.savings.shared.model.SavingsProduct getSavingsProduct(java.lang.String productId)
                                                                throws MambuApiException

Get a Savings Product by Product id

Parameters:

productId - the id of the product

Returns:

the Savings Product

Throws:

MambuApiException

createSavingsAccount

public com.mambu.api.server.handler.savings.model.JSONSavingsAccount createSavingsAccount(com.mambu.api.server.handler.savings.model.JSONSavingsAccount jsonSavingsAccount)
                                                                                   throws MambuApiException

Create new SavingsAccount using JSONSavingsAccount object and sending it via the JSON API. This API allows creating SavingsAccount with details, including creating custom field values.

Parameters:

jsonSavingsAccount - JSONSavingsAccount object containing SavingsAccount. Must be not null. SavingsAccount's encodedKey must be null for account create

Returns:

created JSONSavingsAccount

Throws:

MambuApiException

createSavingsAccount

public com.mambu.savings.shared.model.SavingsAccount createSavingsAccount(com.mambu.savings.shared.model.SavingsAccount savingsAccount)
                                                                   throws MambuApiException

Convenience method to create new SavingsAccount using SavingsAccount object.

Parameters:

savingsAccount - SavingsAccount object. Must not be null. SavingsAccount's encodedKey must be null for account create

Returns:

created savings account

Throws:

MambuApiException

updateSavingsAccount

public com.mambu.api.server.handler.savings.model.JSONSavingsAccount updateSavingsAccount(com.mambu.api.server.handler.savings.model.JSONSavingsAccount jsonSavingsAccount)
                                                                                   throws MambuApiException

Update an existent SavingsAccount using JSONSavingsAccount object and sending it via the JSON API. This API allows updating JSONSavingsAccount with details. As of Mambu 3.4 only custom fields can be updated.

Parameters:

jsonSavingsAccount - JSONSavingsAccount object containing SavingsAccount. SavingsAccount encodedKey or id must be NOT null for account update

Returns:

updated JSONSavingsAccount

Throws:

MambuApiException

updateSavingsAccount

public com.mambu.savings.shared.model.SavingsAccount updateSavingsAccount(com.mambu.savings.shared.model.SavingsAccount savingsAccount)
                                                                   throws MambuApiException

Convenience method to Update an existent SavingsAccount. As of Mambu 3.4 only custom fields can be updated.

Parameters:

savingsAccount - savings account object to be updated. Must not be null. SavingsAccount encodedKey or id must be NOT null for account update

Returns:

savingsAccount

Throws:

MambuApiException

patchSavingsAccount

public boolean patchSavingsAccount(com.mambu.savings.shared.model.SavingsAccount savings)
                            throws MambuApiException

Update savings terms for an existent savings account This API allows updating SavingsAccount terms only. Use updateSavingsAccount() to update custom fields for a savings account

Parameters:

savings - SavingsAccount object. Either account's encoded key or its ID must be NOT null for updating account Note that only some savings terms can be updated. As of Mambu 3.14 the following fields can be updated: interestRate, maxWidthdrawlAmount, recommendedDepositAmount, targetAmount, overdraftInterestSpread, overdraftLimit, overdraftExpiryDate. See MBU-10447 for more details

Throws:

MambuApiException

java.lang.IllegalArgumentException

getFundedLoanAccounts

public java.util.List<com.mambu.loans.shared.model.LoanAccount> getFundedLoanAccounts(java.lang.String savingsId)
                                                                               throws MambuApiException

Get all loan accounts funded by a deposit investor account

Parameters:

savingsId - encoded key or an id of an investor funding savings account. Must not be null

Returns:

all loan accounts funded by the deposit account

Throws:

MambuApiException