io.swagger.client.api

Class AccountsApi

java.lang.Object

io.swagger.client.api.AccountsApi

public class AccountsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AccountsApi()
AccountsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deleteAccount(Long id) Delete an account Delete a single bank account of the user that is authorized by the access_token, including its transactions and balance data.
com.squareup.okhttp.Call	deleteAccountAsync(Long id, ApiCallback<Void> callback) Delete an account (asynchronously) Delete a single bank account of the user that is authorized by the access_token, including its transactions and balance data.
com.squareup.okhttp.Call	deleteAccountCall(Long id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteAccount
ApiResponse<Void>	deleteAccountWithHttpInfo(Long id) Delete an account Delete a single bank account of the user that is authorized by the access_token, including its transactions and balance data.
IdentifierList	deleteAllAccounts() Delete all accounts Delete all accounts of the user that is authorized by the access_token, including all transactions and balance data.
com.squareup.okhttp.Call	deleteAllAccountsAsync(ApiCallback<IdentifierList> callback) Delete all accounts (asynchronously) Delete all accounts of the user that is authorized by the access_token, including all transactions and balance data.
com.squareup.okhttp.Call	deleteAllAccountsCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteAllAccounts
ApiResponse<IdentifierList>	deleteAllAccountsWithHttpInfo() Delete all accounts Delete all accounts of the user that is authorized by the access_token, including all transactions and balance data.
Account	editAccount(Long id, AccountParams body) Edit an account Change the name and/or the type and/or the 'isNew' flag of a single bank account of the user that is authorized by the access_token.
com.squareup.okhttp.Call	editAccountAsync(Long id, AccountParams body, ApiCallback<Account> callback) Edit an account (asynchronously) Change the name and/or the type and/or the 'isNew' flag of a single bank account of the user that is authorized by the access_token.
com.squareup.okhttp.Call	editAccountCall(Long id, AccountParams body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for editAccount
ApiResponse<Account>	editAccountWithHttpInfo(Long id, AccountParams body) Edit an account Change the name and/or the type and/or the 'isNew' flag of a single bank account of the user that is authorized by the access_token.
BankResponse	executeSepaDirectDebit(ExecuteSepaDirectDebitParams body) Execute SEPA Direct Debit Execute a SEPA direct debit order that has been previously submitted by the use of the /requestSepaDirectDebit service.
com.squareup.okhttp.Call	executeSepaDirectDebitAsync(ExecuteSepaDirectDebitParams body, ApiCallback<BankResponse> callback) Execute SEPA Direct Debit (asynchronously) Execute a SEPA direct debit order that has been previously submitted by the use of the /requestSepaDirectDebit service.
com.squareup.okhttp.Call	executeSepaDirectDebitCall(ExecuteSepaDirectDebitParams body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for executeSepaDirectDebit
ApiResponse<BankResponse>	executeSepaDirectDebitWithHttpInfo(ExecuteSepaDirectDebitParams body) Execute SEPA Direct Debit Execute a SEPA direct debit order that has been previously submitted by the use of the /requestSepaDirectDebit service.
BankResponse	executeSepaMoneyTransfer(ExecuteSepaMoneyTransferParams body) Execute SEPA Money Transfer Execute a SEPA money transfer order that has been previously submitted by the use of the /requestSepaMoneyTransfer service.
com.squareup.okhttp.Call	executeSepaMoneyTransferAsync(ExecuteSepaMoneyTransferParams body, ApiCallback<BankResponse> callback) Execute SEPA Money Transfer (asynchronously) Execute a SEPA money transfer order that has been previously submitted by the use of the /requestSepaMoneyTransfer service.
com.squareup.okhttp.Call	executeSepaMoneyTransferCall(ExecuteSepaMoneyTransferParams body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for executeSepaMoneyTransfer
ApiResponse<BankResponse>	executeSepaMoneyTransferWithHttpInfo(ExecuteSepaMoneyTransferParams body) Execute SEPA Money Transfer Execute a SEPA money transfer order that has been previously submitted by the use of the /requestSepaMoneyTransfer service.
Account	getAccount(Long id) Get an account Get a single bank account of the user that is authorized by the access_token.
com.squareup.okhttp.Call	getAccountAsync(Long id, ApiCallback<Account> callback) Get an account (asynchronously) Get a single bank account of the user that is authorized by the access_token.
com.squareup.okhttp.Call	getAccountCall(Long id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAccount
ApiResponse<Account>	getAccountWithHttpInfo(Long id) Get an account Get a single bank account of the user that is authorized by the access_token.
AccountList	getAndSearchAllAccounts(List<Long> ids, String search, List<Long> accountTypeIds, List<Long> bankConnectionIds, String minLastSuccessfulUpdate, String maxLastSuccessfulUpdate, BigDecimal minBalance, BigDecimal maxBalance) Get and search all accounts Get bank accounts of the user that is authorized by the access_token.
com.squareup.okhttp.Call	getAndSearchAllAccountsAsync(List<Long> ids, String search, List<Long> accountTypeIds, List<Long> bankConnectionIds, String minLastSuccessfulUpdate, String maxLastSuccessfulUpdate, BigDecimal minBalance, BigDecimal maxBalance, ApiCallback<AccountList> callback) Get and search all accounts (asynchronously) Get bank accounts of the user that is authorized by the access_token.
com.squareup.okhttp.Call	getAndSearchAllAccountsCall(List<Long> ids, String search, List<Long> accountTypeIds, List<Long> bankConnectionIds, String minLastSuccessfulUpdate, String maxLastSuccessfulUpdate, BigDecimal minBalance, BigDecimal maxBalance, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAndSearchAllAccounts
ApiResponse<AccountList>	getAndSearchAllAccountsWithHttpInfo(List<Long> ids, String search, List<Long> accountTypeIds, List<Long> bankConnectionIds, String minLastSuccessfulUpdate, String maxLastSuccessfulUpdate, BigDecimal minBalance, BigDecimal maxBalance) Get and search all accounts Get bank accounts of the user that is authorized by the access_token.
ApiClient	getApiClient()
DailyBalanceList	getDailyBalances(List<Long> accountIds, String startDate, String endDate, Boolean withProjection, Integer page, Integer perPage, List<String> order) Get daily balances Returns the daily balances for the given accounts and the given period.
com.squareup.okhttp.Call	getDailyBalancesAsync(List<Long> accountIds, String startDate, String endDate, Boolean withProjection, Integer page, Integer perPage, List<String> order, ApiCallback<DailyBalanceList> callback) Get daily balances (asynchronously) Returns the daily balances for the given accounts and the given period.
com.squareup.okhttp.Call	getDailyBalancesCall(List<Long> accountIds, String startDate, String endDate, Boolean withProjection, Integer page, Integer perPage, List<String> order, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getDailyBalances
ApiResponse<DailyBalanceList>	getDailyBalancesWithHttpInfo(List<Long> accountIds, String startDate, String endDate, Boolean withProjection, Integer page, Integer perPage, List<String> order) Get daily balances Returns the daily balances for the given accounts and the given period.
AccountList	getMultipleAccounts(List<Long> ids) Deprecated.
com.squareup.okhttp.Call	getMultipleAccountsAsync(List<Long> ids, ApiCallback<AccountList> callback) Deprecated.
com.squareup.okhttp.Call	getMultipleAccountsCall(List<Long> ids, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Deprecated.
ApiResponse<AccountList>	getMultipleAccountsWithHttpInfo(List<Long> ids) Deprecated.
DirectDebitOrderingResponse	requestSepaDirectDebit(RequestSepaDirectDebitParams body) Request SEPA Direct Debit Submit a SEPA direct debit order for one or multiple direct debits.
com.squareup.okhttp.Call	requestSepaDirectDebitAsync(RequestSepaDirectDebitParams body, ApiCallback<DirectDebitOrderingResponse> callback) Request SEPA Direct Debit (asynchronously) Submit a SEPA direct debit order for one or multiple direct debits.
com.squareup.okhttp.Call	requestSepaDirectDebitCall(RequestSepaDirectDebitParams body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for requestSepaDirectDebit
ApiResponse<DirectDebitOrderingResponse>	requestSepaDirectDebitWithHttpInfo(RequestSepaDirectDebitParams body) Request SEPA Direct Debit Submit a SEPA direct debit order for one or multiple direct debits.
MoneyTransferOrderingResponse	requestSepaMoneyTransfer(RequestSepaMoneyTransferParams body) Request SEPA Money Transfer Submit a SEPA money transfer order for either a single or a collective money transfer.
com.squareup.okhttp.Call	requestSepaMoneyTransferAsync(RequestSepaMoneyTransferParams body, ApiCallback<MoneyTransferOrderingResponse> callback) Request SEPA Money Transfer (asynchronously) Submit a SEPA money transfer order for either a single or a collective money transfer.
com.squareup.okhttp.Call	requestSepaMoneyTransferCall(RequestSepaMoneyTransferParams body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for requestSepaMoneyTransfer
ApiResponse<MoneyTransferOrderingResponse>	requestSepaMoneyTransferWithHttpInfo(RequestSepaMoneyTransferParams body) Request SEPA Money Transfer Submit a SEPA money transfer order for either a single or a collective money transfer.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountsApi

public AccountsApi()

AccountsApi

public AccountsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteAccountCall

public com.squareup.okhttp.Call deleteAccountCall(Long id,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for deleteAccount

Parameters:

id - Identifier of the account to delete (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteAccount

public void deleteAccount(Long id)
                   throws ApiException

Delete an account Delete a single bank account of the user that is authorized by the access_token, including its transactions and balance data. Must pass the account's identifier and the user's access_token.<br/><br/>Notes: <br/>- You cannot delete an account while the bank connection that it relates to is currently in the process of import, update, or transactions categorization. <br/>- When the last remaining account of a bank connection gets deleted, then the bank connection itself will get deleted as well! <br/>- All notification rules that are connected to the account will get adjusted so that they no longer have this account listed. Notification rules that are connected to just this account (and no other accounts) will get deleted altogether.

Parameters:

id - Identifier of the account to delete (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteAccountWithHttpInfo

public ApiResponse<Void> deleteAccountWithHttpInfo(Long id)
                                            throws ApiException

Delete an account Delete a single bank account of the user that is authorized by the access_token, including its transactions and balance data. Must pass the account's identifier and the user's access_token.<br/><br/>Notes: <br/>- You cannot delete an account while the bank connection that it relates to is currently in the process of import, update, or transactions categorization. <br/>- When the last remaining account of a bank connection gets deleted, then the bank connection itself will get deleted as well! <br/>- All notification rules that are connected to the account will get adjusted so that they no longer have this account listed. Notification rules that are connected to just this account (and no other accounts) will get deleted altogether.

Parameters:

id - Identifier of the account to delete (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteAccountAsync

public com.squareup.okhttp.Call deleteAccountAsync(Long id,
                                                   ApiCallback<Void> callback)
                                            throws ApiException

Delete an account (asynchronously) Delete a single bank account of the user that is authorized by the access_token, including its transactions and balance data. Must pass the account's identifier and the user's access_token.<br/><br/>Notes: <br/>- You cannot delete an account while the bank connection that it relates to is currently in the process of import, update, or transactions categorization. <br/>- When the last remaining account of a bank connection gets deleted, then the bank connection itself will get deleted as well! <br/>- All notification rules that are connected to the account will get adjusted so that they no longer have this account listed. Notification rules that are connected to just this account (and no other accounts) will get deleted altogether.

Parameters:

id - Identifier of the account to delete (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

deleteAllAccountsCall

public com.squareup.okhttp.Call deleteAllAccountsCall(ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for deleteAllAccounts

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteAllAccounts

public IdentifierList deleteAllAccounts()
                                 throws ApiException

Delete all accounts Delete all accounts of the user that is authorized by the access_token, including all transactions and balance data. Must pass the user's access_token.<br/><br/>Notes: <br/>- Deleting all of the user's accounts also deletes all of his bank connections. <br/>- All notification rules that are connected to any specific accounts will get deleted as well. <br/>- If at least one of the user's bank connections in currently in the process of import, update, or transactions categorization, then this service will perform no action at all.

Returns:

IdentifierList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteAllAccountsWithHttpInfo

public ApiResponse<IdentifierList> deleteAllAccountsWithHttpInfo()
                                                          throws ApiException

Delete all accounts Delete all accounts of the user that is authorized by the access_token, including all transactions and balance data. Must pass the user's access_token.<br/><br/>Notes: <br/>- Deleting all of the user's accounts also deletes all of his bank connections. <br/>- All notification rules that are connected to any specific accounts will get deleted as well. <br/>- If at least one of the user's bank connections in currently in the process of import, update, or transactions categorization, then this service will perform no action at all.

Returns:

ApiResponse<IdentifierList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteAllAccountsAsync

public com.squareup.okhttp.Call deleteAllAccountsAsync(ApiCallback<IdentifierList> callback)
                                                throws ApiException

Delete all accounts (asynchronously) Delete all accounts of the user that is authorized by the access_token, including all transactions and balance data. Must pass the user's access_token.<br/><br/>Notes: <br/>- Deleting all of the user's accounts also deletes all of his bank connections. <br/>- All notification rules that are connected to any specific accounts will get deleted as well. <br/>- If at least one of the user's bank connections in currently in the process of import, update, or transactions categorization, then this service will perform no action at all.

Parameters:

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

editAccountCall

public com.squareup.okhttp.Call editAccountCall(Long id,
                                                AccountParams body,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for editAccount

Parameters:

id - Identifier of the account to edit (required)

body - New account name and/or type and/or 'isNew' flag (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

editAccount

public Account editAccount(Long id,
                           AccountParams body)
                    throws ApiException

Edit an account Change the name and/or the type and/or the 'isNew' flag of a single bank account of the user that is authorized by the access_token. Must pass the account's identifier, the account's new name and/or type and/or 'isNew' flag, and the user's access_token.

Parameters:

id - Identifier of the account to edit (required)

body - New account name and/or type and/or 'isNew' flag (optional)

Returns:

Account

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

editAccountWithHttpInfo

public ApiResponse<Account> editAccountWithHttpInfo(Long id,
                                                    AccountParams body)
                                             throws ApiException

Edit an account Change the name and/or the type and/or the 'isNew' flag of a single bank account of the user that is authorized by the access_token. Must pass the account's identifier, the account's new name and/or type and/or 'isNew' flag, and the user's access_token.

Parameters:

id - Identifier of the account to edit (required)

body - New account name and/or type and/or 'isNew' flag (optional)

Returns:

ApiResponse<Account>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

editAccountAsync

public com.squareup.okhttp.Call editAccountAsync(Long id,
                                                 AccountParams body,
                                                 ApiCallback<Account> callback)
                                          throws ApiException

Edit an account (asynchronously) Change the name and/or the type and/or the 'isNew' flag of a single bank account of the user that is authorized by the access_token. Must pass the account's identifier, the account's new name and/or type and/or 'isNew' flag, and the user's access_token.

Parameters:

id - Identifier of the account to edit (required)

body - New account name and/or type and/or 'isNew' flag (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

executeSepaDirectDebitCall

public com.squareup.okhttp.Call executeSepaDirectDebitCall(ExecuteSepaDirectDebitParams body,
                                                           ProgressResponseBody.ProgressListener progressListener,
                                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                    throws ApiException

Build call for executeSepaDirectDebit

Parameters:

body - Parameters for the execution of a SEPA direct debit order (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

executeSepaDirectDebit

public BankResponse executeSepaDirectDebit(ExecuteSepaDirectDebitParams body)
                                    throws ApiException

Execute SEPA Direct Debit Execute a SEPA direct debit order that has been previously submitted by the use of the /requestSepaDirectDebit service. Note that this service cannot be used for the demo account.

Parameters:

body - Parameters for the execution of a SEPA direct debit order (required)

Returns:

BankResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

executeSepaDirectDebitWithHttpInfo

public ApiResponse<BankResponse> executeSepaDirectDebitWithHttpInfo(ExecuteSepaDirectDebitParams body)
                                                             throws ApiException

Execute SEPA Direct Debit Execute a SEPA direct debit order that has been previously submitted by the use of the /requestSepaDirectDebit service. Note that this service cannot be used for the demo account.

Parameters:

body - Parameters for the execution of a SEPA direct debit order (required)

Returns:

ApiResponse<BankResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

executeSepaDirectDebitAsync

public com.squareup.okhttp.Call executeSepaDirectDebitAsync(ExecuteSepaDirectDebitParams body,
                                                            ApiCallback<BankResponse> callback)
                                                     throws ApiException

Execute SEPA Direct Debit (asynchronously) Execute a SEPA direct debit order that has been previously submitted by the use of the /requestSepaDirectDebit service. Note that this service cannot be used for the demo account.

Parameters:

body - Parameters for the execution of a SEPA direct debit order (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

executeSepaMoneyTransferCall

public com.squareup.okhttp.Call executeSepaMoneyTransferCall(ExecuteSepaMoneyTransferParams body,
                                                             ProgressResponseBody.ProgressListener progressListener,
                                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                      throws ApiException

Build call for executeSepaMoneyTransfer

Parameters:

body - Parameters for the execution of a SEPA money transfer order (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

executeSepaMoneyTransfer

public BankResponse executeSepaMoneyTransfer(ExecuteSepaMoneyTransferParams body)
                                      throws ApiException

Execute SEPA Money Transfer Execute a SEPA money transfer order that has been previously submitted by the use of the /requestSepaMoneyTransfer service. Note that this service cannot be used for the demo account.

Parameters:

body - Parameters for the execution of a SEPA money transfer order (required)

Returns:

BankResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

executeSepaMoneyTransferWithHttpInfo

public ApiResponse<BankResponse> executeSepaMoneyTransferWithHttpInfo(ExecuteSepaMoneyTransferParams body)
                                                               throws ApiException

Execute SEPA Money Transfer Execute a SEPA money transfer order that has been previously submitted by the use of the /requestSepaMoneyTransfer service. Note that this service cannot be used for the demo account.

Parameters:

body - Parameters for the execution of a SEPA money transfer order (required)

Returns:

ApiResponse<BankResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

executeSepaMoneyTransferAsync

public com.squareup.okhttp.Call executeSepaMoneyTransferAsync(ExecuteSepaMoneyTransferParams body,
                                                              ApiCallback<BankResponse> callback)
                                                       throws ApiException

Execute SEPA Money Transfer (asynchronously) Execute a SEPA money transfer order that has been previously submitted by the use of the /requestSepaMoneyTransfer service. Note that this service cannot be used for the demo account.

Parameters:

body - Parameters for the execution of a SEPA money transfer order (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getAccountCall

public com.squareup.okhttp.Call getAccountCall(Long id,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for getAccount

Parameters:

id - Identifier of requested account (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAccount

public Account getAccount(Long id)
                   throws ApiException

Get an account Get a single bank account of the user that is authorized by the access_token. Must pass the account's identifier and the user's access_token.

Parameters:

id - Identifier of requested account (required)

Returns:

Account

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAccountWithHttpInfo

public ApiResponse<Account> getAccountWithHttpInfo(Long id)
                                            throws ApiException

Get an account Get a single bank account of the user that is authorized by the access_token. Must pass the account's identifier and the user's access_token.

Parameters:

id - Identifier of requested account (required)

Returns:

ApiResponse<Account>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAccountAsync

public com.squareup.okhttp.Call getAccountAsync(Long id,
                                                ApiCallback<Account> callback)
                                         throws ApiException

Get an account (asynchronously) Get a single bank account of the user that is authorized by the access_token. Must pass the account's identifier and the user's access_token.

Parameters:

id - Identifier of requested account (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getAndSearchAllAccountsCall

public com.squareup.okhttp.Call getAndSearchAllAccountsCall(List<Long> ids,
                                                            String search,
                                                            List<Long> accountTypeIds,
                                                            List<Long> bankConnectionIds,
                                                            String minLastSuccessfulUpdate,
                                                            String maxLastSuccessfulUpdate,
                                                            BigDecimal minBalance,
                                                            BigDecimal maxBalance,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for getAndSearchAllAccounts

Parameters:

ids - A comma-separated list of account identifiers. If specified, then only accounts whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)

search - If specified, then only those accounts will be contained in the result whose 'accountName', 'iban', 'accountNumber' or 'subAccountNumber' contains the given search string (the matching works case-insensitive). If no accounts contain the search string in any of these fields, then the result will be an empty list. NOTE: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must be contained in the searched fields in order for an account to get included into the result. (optional)

accountTypeIds - A comma-separated list of account types. If specified, then only accounts that relate to the given types will be regarded. If not specified, then all accounts will be regarded. (optional)

bankConnectionIds - A comma-separated list of bank connection identifiers. If specified, then only accounts that relate to the given bank connections will be regarded. If not specified, then all accounts will be regarded. (optional)

minLastSuccessfulUpdate - Lower bound for a account's last successful update date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only accounts whose 'lastSuccessfulUpdate' is equal to or later than the given date will be regarded. (optional)

maxLastSuccessfulUpdate - Upper bound for a account's last successful update date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only accounts whose 'lastSuccessfulUpdate' is equal to or earlier than the given date will be regarded. (optional)

minBalance - If specified, then only accounts whose balance is equal to or greater than the given balance will be regarded. Can contain a positive or negative number with at most two decimal places. Examples: -300.12, or 90.95 (optional)

maxBalance - If specified, then only accounts whose balance is equal to or less than the given balance will be regarded. Can contain a positive or negative number with at most two decimal places. Examples: -300.12, or 90.95 (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAndSearchAllAccounts

public AccountList getAndSearchAllAccounts(List<Long> ids,
                                           String search,
                                           List<Long> accountTypeIds,
                                           List<Long> bankConnectionIds,
                                           String minLastSuccessfulUpdate,
                                           String maxLastSuccessfulUpdate,
                                           BigDecimal minBalance,
                                           BigDecimal maxBalance)
                                    throws ApiException

Get and search all accounts Get bank accounts of the user that is authorized by the access_token. Must pass the user's access_token. You can set optional search criteria to get only those bank accounts that you are interested in. If you do not specify any search criteria, then this service functions as a 'get all' service.

Parameters:

ids - A comma-separated list of account identifiers. If specified, then only accounts whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)

search - If specified, then only those accounts will be contained in the result whose 'accountName', 'iban', 'accountNumber' or 'subAccountNumber' contains the given search string (the matching works case-insensitive). If no accounts contain the search string in any of these fields, then the result will be an empty list. NOTE: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must be contained in the searched fields in order for an account to get included into the result. (optional)

accountTypeIds - A comma-separated list of account types. If specified, then only accounts that relate to the given types will be regarded. If not specified, then all accounts will be regarded. (optional)

bankConnectionIds - A comma-separated list of bank connection identifiers. If specified, then only accounts that relate to the given bank connections will be regarded. If not specified, then all accounts will be regarded. (optional)

minLastSuccessfulUpdate - Lower bound for a account's last successful update date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only accounts whose 'lastSuccessfulUpdate' is equal to or later than the given date will be regarded. (optional)

maxLastSuccessfulUpdate - Upper bound for a account's last successful update date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only accounts whose 'lastSuccessfulUpdate' is equal to or earlier than the given date will be regarded. (optional)

minBalance - If specified, then only accounts whose balance is equal to or greater than the given balance will be regarded. Can contain a positive or negative number with at most two decimal places. Examples: -300.12, or 90.95 (optional)

maxBalance - If specified, then only accounts whose balance is equal to or less than the given balance will be regarded. Can contain a positive or negative number with at most two decimal places. Examples: -300.12, or 90.95 (optional)

Returns:

AccountList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAndSearchAllAccountsWithHttpInfo

public ApiResponse<AccountList> getAndSearchAllAccountsWithHttpInfo(List<Long> ids,
                                                                    String search,
                                                                    List<Long> accountTypeIds,
                                                                    List<Long> bankConnectionIds,
                                                                    String minLastSuccessfulUpdate,
                                                                    String maxLastSuccessfulUpdate,
                                                                    BigDecimal minBalance,
                                                                    BigDecimal maxBalance)
                                                             throws ApiException

Get and search all accounts Get bank accounts of the user that is authorized by the access_token. Must pass the user's access_token. You can set optional search criteria to get only those bank accounts that you are interested in. If you do not specify any search criteria, then this service functions as a 'get all' service.

Parameters:

ids - A comma-separated list of account identifiers. If specified, then only accounts whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)

search - If specified, then only those accounts will be contained in the result whose 'accountName', 'iban', 'accountNumber' or 'subAccountNumber' contains the given search string (the matching works case-insensitive). If no accounts contain the search string in any of these fields, then the result will be an empty list. NOTE: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must be contained in the searched fields in order for an account to get included into the result. (optional)

accountTypeIds - A comma-separated list of account types. If specified, then only accounts that relate to the given types will be regarded. If not specified, then all accounts will be regarded. (optional)

bankConnectionIds - A comma-separated list of bank connection identifiers. If specified, then only accounts that relate to the given bank connections will be regarded. If not specified, then all accounts will be regarded. (optional)

minLastSuccessfulUpdate - Lower bound for a account's last successful update date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only accounts whose 'lastSuccessfulUpdate' is equal to or later than the given date will be regarded. (optional)

maxLastSuccessfulUpdate - Upper bound for a account's last successful update date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only accounts whose 'lastSuccessfulUpdate' is equal to or earlier than the given date will be regarded. (optional)

minBalance - If specified, then only accounts whose balance is equal to or greater than the given balance will be regarded. Can contain a positive or negative number with at most two decimal places. Examples: -300.12, or 90.95 (optional)

maxBalance - If specified, then only accounts whose balance is equal to or less than the given balance will be regarded. Can contain a positive or negative number with at most two decimal places. Examples: -300.12, or 90.95 (optional)

Returns:

ApiResponse<AccountList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAndSearchAllAccountsAsync

public com.squareup.okhttp.Call getAndSearchAllAccountsAsync(List<Long> ids,
                                                             String search,
                                                             List<Long> accountTypeIds,
                                                             List<Long> bankConnectionIds,
                                                             String minLastSuccessfulUpdate,
                                                             String maxLastSuccessfulUpdate,
                                                             BigDecimal minBalance,
                                                             BigDecimal maxBalance,
                                                             ApiCallback<AccountList> callback)
                                                      throws ApiException

Get and search all accounts (asynchronously) Get bank accounts of the user that is authorized by the access_token. Must pass the user's access_token. You can set optional search criteria to get only those bank accounts that you are interested in. If you do not specify any search criteria, then this service functions as a 'get all' service.

Parameters:

ids - A comma-separated list of account identifiers. If specified, then only accounts whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)

search - If specified, then only those accounts will be contained in the result whose 'accountName', 'iban', 'accountNumber' or 'subAccountNumber' contains the given search string (the matching works case-insensitive). If no accounts contain the search string in any of these fields, then the result will be an empty list. NOTE: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must be contained in the searched fields in order for an account to get included into the result. (optional)

accountTypeIds - A comma-separated list of account types. If specified, then only accounts that relate to the given types will be regarded. If not specified, then all accounts will be regarded. (optional)

bankConnectionIds - A comma-separated list of bank connection identifiers. If specified, then only accounts that relate to the given bank connections will be regarded. If not specified, then all accounts will be regarded. (optional)

minLastSuccessfulUpdate - Lower bound for a account's last successful update date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only accounts whose 'lastSuccessfulUpdate' is equal to or later than the given date will be regarded. (optional)

maxLastSuccessfulUpdate - Upper bound for a account's last successful update date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only accounts whose 'lastSuccessfulUpdate' is equal to or earlier than the given date will be regarded. (optional)

minBalance - If specified, then only accounts whose balance is equal to or greater than the given balance will be regarded. Can contain a positive or negative number with at most two decimal places. Examples: -300.12, or 90.95 (optional)

maxBalance - If specified, then only accounts whose balance is equal to or less than the given balance will be regarded. Can contain a positive or negative number with at most two decimal places. Examples: -300.12, or 90.95 (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getDailyBalancesCall

public com.squareup.okhttp.Call getDailyBalancesCall(List<Long> accountIds,
                                                     String startDate,
                                                     String endDate,
                                                     Boolean withProjection,
                                                     Integer page,
                                                     Integer perPage,
                                                     List<String> order,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for getDailyBalances

Parameters:

accountIds - A comma-separated list of (non-security) account identifiers. If no accounts are specified, all (non-security) accounts of the current user are regarded. (optional)

startDate - A string in the format 'YYYY-MM-DD'. Note that the requested date range [startDate..endDate] may not exceed 365 days. If startDate is not specified, it defaults to the endDate minus one month. (optional)

endDate - A string in the format 'YYYY-MM-DD'. Note that the requested date range [startDate..endDate] may not exceed 365 days. If endDate is not specified, it defaults to today's date. (optional)

withProjection - Whether finAPI should project the first and last actually existing balance into the past and future. When passing 'true', then the result will always contain a daily balance for every day of the entire requested date range, even for days before the first actually existing balance, resp. after the last actually existing balance. Those days will have the same balance as the day of the first actual balance, resp. last actual balance, i.e. the first/last balance will be infinitely projected into the past/the future. When passing 'false', then the result will contain daily balances only from the day on where the first actual balance exists for any of the given accounts, and only up to the day where the last actual balance exists for any of the given accounts. Note that when in this case there are no actual balances within the requested date range, then an empty array will be returned. Default value for this parameter is 'true'. (optional, default to true)

page - Result page that you want to retrieve. (optional, default to 1)

perPage - Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. (optional, default to 20)

order - Determines the order of the results. You can order the results by 'date', 'balance', 'income' or 'spending'. The default order for this service is 'date,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. Example: '/accounts/dailyBalances?order=date,desc&order=balance,asc' will return daily balances ordered by 'date' (descending), where items with the same 'date' are ordered by 'balance' (ascending). The general format is: 'property[,asc|desc]', with 'asc' being the default value. Please note that ordering by multiple fields is not supported in our swagger frontend, but you can test this feature with any HTTP tool of your choice (e.g. postman or DHC). (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getDailyBalances

public DailyBalanceList getDailyBalances(List<Long> accountIds,
                                         String startDate,
                                         String endDate,
                                         Boolean withProjection,
                                         Integer page,
                                         Integer perPage,
                                         List<String> order)
                                  throws ApiException

Get daily balances Returns the daily balances for the given accounts and the given period. The balances are calculated by finAPI and are based on each account's latest balance.

Parameters:

accountIds - A comma-separated list of (non-security) account identifiers. If no accounts are specified, all (non-security) accounts of the current user are regarded. (optional)

startDate - A string in the format 'YYYY-MM-DD'. Note that the requested date range [startDate..endDate] may not exceed 365 days. If startDate is not specified, it defaults to the endDate minus one month. (optional)

endDate - A string in the format 'YYYY-MM-DD'. Note that the requested date range [startDate..endDate] may not exceed 365 days. If endDate is not specified, it defaults to today's date. (optional)

withProjection - Whether finAPI should project the first and last actually existing balance into the past and future. When passing 'true', then the result will always contain a daily balance for every day of the entire requested date range, even for days before the first actually existing balance, resp. after the last actually existing balance. Those days will have the same balance as the day of the first actual balance, resp. last actual balance, i.e. the first/last balance will be infinitely projected into the past/the future. When passing 'false', then the result will contain daily balances only from the day on where the first actual balance exists for any of the given accounts, and only up to the day where the last actual balance exists for any of the given accounts. Note that when in this case there are no actual balances within the requested date range, then an empty array will be returned. Default value for this parameter is 'true'. (optional, default to true)

page - Result page that you want to retrieve. (optional, default to 1)

perPage - Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. (optional, default to 20)

order - Determines the order of the results. You can order the results by 'date', 'balance', 'income' or 'spending'. The default order for this service is 'date,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. Example: '/accounts/dailyBalances?order=date,desc&order=balance,asc' will return daily balances ordered by 'date' (descending), where items with the same 'date' are ordered by 'balance' (ascending). The general format is: 'property[,asc|desc]', with 'asc' being the default value. Please note that ordering by multiple fields is not supported in our swagger frontend, but you can test this feature with any HTTP tool of your choice (e.g. postman or DHC). (optional)

Returns:

DailyBalanceList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getDailyBalancesWithHttpInfo

public ApiResponse<DailyBalanceList> getDailyBalancesWithHttpInfo(List<Long> accountIds,
                                                                  String startDate,
                                                                  String endDate,
                                                                  Boolean withProjection,
                                                                  Integer page,
                                                                  Integer perPage,
                                                                  List<String> order)
                                                           throws ApiException

Get daily balances Returns the daily balances for the given accounts and the given period. The balances are calculated by finAPI and are based on each account's latest balance.

Parameters:

accountIds - A comma-separated list of (non-security) account identifiers. If no accounts are specified, all (non-security) accounts of the current user are regarded. (optional)

startDate - A string in the format 'YYYY-MM-DD'. Note that the requested date range [startDate..endDate] may not exceed 365 days. If startDate is not specified, it defaults to the endDate minus one month. (optional)

endDate - A string in the format 'YYYY-MM-DD'. Note that the requested date range [startDate..endDate] may not exceed 365 days. If endDate is not specified, it defaults to today's date. (optional)

withProjection - Whether finAPI should project the first and last actually existing balance into the past and future. When passing 'true', then the result will always contain a daily balance for every day of the entire requested date range, even for days before the first actually existing balance, resp. after the last actually existing balance. Those days will have the same balance as the day of the first actual balance, resp. last actual balance, i.e. the first/last balance will be infinitely projected into the past/the future. When passing 'false', then the result will contain daily balances only from the day on where the first actual balance exists for any of the given accounts, and only up to the day where the last actual balance exists for any of the given accounts. Note that when in this case there are no actual balances within the requested date range, then an empty array will be returned. Default value for this parameter is 'true'. (optional, default to true)

page - Result page that you want to retrieve. (optional, default to 1)

perPage - Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. (optional, default to 20)

order - Determines the order of the results. You can order the results by 'date', 'balance', 'income' or 'spending'. The default order for this service is 'date,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. Example: '/accounts/dailyBalances?order=date,desc&order=balance,asc' will return daily balances ordered by 'date' (descending), where items with the same 'date' are ordered by 'balance' (ascending). The general format is: 'property[,asc|desc]', with 'asc' being the default value. Please note that ordering by multiple fields is not supported in our swagger frontend, but you can test this feature with any HTTP tool of your choice (e.g. postman or DHC). (optional)

Returns:

ApiResponse<DailyBalanceList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getDailyBalancesAsync

public com.squareup.okhttp.Call getDailyBalancesAsync(List<Long> accountIds,
                                                      String startDate,
                                                      String endDate,
                                                      Boolean withProjection,
                                                      Integer page,
                                                      Integer perPage,
                                                      List<String> order,
                                                      ApiCallback<DailyBalanceList> callback)
                                               throws ApiException

Get daily balances (asynchronously) Returns the daily balances for the given accounts and the given period. The balances are calculated by finAPI and are based on each account's latest balance.

Parameters:

accountIds - A comma-separated list of (non-security) account identifiers. If no accounts are specified, all (non-security) accounts of the current user are regarded. (optional)

startDate - A string in the format 'YYYY-MM-DD'. Note that the requested date range [startDate..endDate] may not exceed 365 days. If startDate is not specified, it defaults to the endDate minus one month. (optional)

endDate - A string in the format 'YYYY-MM-DD'. Note that the requested date range [startDate..endDate] may not exceed 365 days. If endDate is not specified, it defaults to today's date. (optional)

withProjection - Whether finAPI should project the first and last actually existing balance into the past and future. When passing 'true', then the result will always contain a daily balance for every day of the entire requested date range, even for days before the first actually existing balance, resp. after the last actually existing balance. Those days will have the same balance as the day of the first actual balance, resp. last actual balance, i.e. the first/last balance will be infinitely projected into the past/the future. When passing 'false', then the result will contain daily balances only from the day on where the first actual balance exists for any of the given accounts, and only up to the day where the last actual balance exists for any of the given accounts. Note that when in this case there are no actual balances within the requested date range, then an empty array will be returned. Default value for this parameter is 'true'. (optional, default to true)

page - Result page that you want to retrieve. (optional, default to 1)

perPage - Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. (optional, default to 20)

order - Determines the order of the results. You can order the results by 'date', 'balance', 'income' or 'spending'. The default order for this service is 'date,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. Example: '/accounts/dailyBalances?order=date,desc&order=balance,asc' will return daily balances ordered by 'date' (descending), where items with the same 'date' are ordered by 'balance' (ascending). The general format is: 'property[,asc|desc]', with 'asc' being the default value. Please note that ordering by multiple fields is not supported in our swagger frontend, but you can test this feature with any HTTP tool of your choice (e.g. postman or DHC). (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getMultipleAccountsCall

@Deprecated
public com.squareup.okhttp.Call getMultipleAccountsCall(List<Long> ids,
                                                                    ProgressResponseBody.ProgressListener progressListener,
                                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                             throws ApiException

Deprecated.

Build call for getMultipleAccounts

Parameters:

ids - Comma-separated list of identifiers of requested accounts (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getMultipleAccounts

@Deprecated
public AccountList getMultipleAccounts(List<Long> ids)
                                            throws ApiException

Deprecated.

Get multiple accounts Get a list of multiple bank accounts of the user that is authorized by the access_token. Must pass the accounts' identifiers and the user's access_token. Accounts whose identifiers do not exist or do not relate to the authorized user will not be contained in the result (If this applies to all of the given identifiers, then the result will be an empty list). WARNING: This service is deprecated and will be removed at some point. If you want to get multiple accounts, please instead use the service 'Get and search all accounts' and pass a comma-separated list of identifiers as a parameter 'ids'.

Parameters:

ids - Comma-separated list of identifiers of requested accounts (required)

Returns:

AccountList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getMultipleAccountsWithHttpInfo

@Deprecated
public ApiResponse<AccountList> getMultipleAccountsWithHttpInfo(List<Long> ids)
                                                                     throws ApiException

Deprecated.

Get multiple accounts Get a list of multiple bank accounts of the user that is authorized by the access_token. Must pass the accounts' identifiers and the user's access_token. Accounts whose identifiers do not exist or do not relate to the authorized user will not be contained in the result (If this applies to all of the given identifiers, then the result will be an empty list). WARNING: This service is deprecated and will be removed at some point. If you want to get multiple accounts, please instead use the service 'Get and search all accounts' and pass a comma-separated list of identifiers as a parameter 'ids'.

Parameters:

ids - Comma-separated list of identifiers of requested accounts (required)

Returns:

ApiResponse<AccountList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getMultipleAccountsAsync

@Deprecated
public com.squareup.okhttp.Call getMultipleAccountsAsync(List<Long> ids,
                                                                     ApiCallback<AccountList> callback)
                                                              throws ApiException

Deprecated.

Get multiple accounts (asynchronously) Get a list of multiple bank accounts of the user that is authorized by the access_token. Must pass the accounts' identifiers and the user's access_token. Accounts whose identifiers do not exist or do not relate to the authorized user will not be contained in the result (If this applies to all of the given identifiers, then the result will be an empty list). WARNING: This service is deprecated and will be removed at some point. If you want to get multiple accounts, please instead use the service 'Get and search all accounts' and pass a comma-separated list of identifiers as a parameter 'ids'.

Parameters:

ids - Comma-separated list of identifiers of requested accounts (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

requestSepaDirectDebitCall

public com.squareup.okhttp.Call requestSepaDirectDebitCall(RequestSepaDirectDebitParams body,
                                                           ProgressResponseBody.ProgressListener progressListener,
                                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                    throws ApiException

Build call for requestSepaDirectDebit

Parameters:

body - Parameters for a SEPA direct debit request (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

requestSepaDirectDebit

public DirectDebitOrderingResponse requestSepaDirectDebit(RequestSepaDirectDebitParams body)
                                                   throws ApiException

Request SEPA Direct Debit Submit a SEPA direct debit order for one or multiple direct debits. Returns an instruction from the bank server that can be displayed to the user (e.g. \"Enter TAN\"), typically in the language of the bank's country. The order remains valid for execution for only a couple of minutes (the exact validity period depends on the bank). For executing the order, use the /executeSepaDirectDebit service after calling this service. Note that when the order is not executed within the validity period, the bank might take note of that and - if happening too often - ultimately lock the user's online banking access. If there already exists a previously submitted but not yet executed SEPA order for this account (either another direct debit order, or a money transfer order), then that order will be discarded and replaced with the new order that is being created with this service call.<br/><br/>Notes:<br/>&bull; This service cannot be used for the demo account.<br/>&bull; When using a two-step-procedure with flag 'implicitExecute' = true, then this service will immediately execute the direct debit. The response will not contain any challenge message and you won't be required to make a subsequent call to /executeSepaDirectDebit.

Parameters:

body - Parameters for a SEPA direct debit request (required)

Returns:

DirectDebitOrderingResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

requestSepaDirectDebitWithHttpInfo

public ApiResponse<DirectDebitOrderingResponse> requestSepaDirectDebitWithHttpInfo(RequestSepaDirectDebitParams body)
                                                                            throws ApiException

Request SEPA Direct Debit Submit a SEPA direct debit order for one or multiple direct debits. Returns an instruction from the bank server that can be displayed to the user (e.g. \"Enter TAN\"), typically in the language of the bank's country. The order remains valid for execution for only a couple of minutes (the exact validity period depends on the bank). For executing the order, use the /executeSepaDirectDebit service after calling this service. Note that when the order is not executed within the validity period, the bank might take note of that and - if happening too often - ultimately lock the user's online banking access. If there already exists a previously submitted but not yet executed SEPA order for this account (either another direct debit order, or a money transfer order), then that order will be discarded and replaced with the new order that is being created with this service call.<br/><br/>Notes:<br/>&bull; This service cannot be used for the demo account.<br/>&bull; When using a two-step-procedure with flag 'implicitExecute' = true, then this service will immediately execute the direct debit. The response will not contain any challenge message and you won't be required to make a subsequent call to /executeSepaDirectDebit.

Parameters:

body - Parameters for a SEPA direct debit request (required)

Returns:

ApiResponse<DirectDebitOrderingResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

requestSepaDirectDebitAsync

public com.squareup.okhttp.Call requestSepaDirectDebitAsync(RequestSepaDirectDebitParams body,
                                                            ApiCallback<DirectDebitOrderingResponse> callback)
                                                     throws ApiException

Request SEPA Direct Debit (asynchronously) Submit a SEPA direct debit order for one or multiple direct debits. Returns an instruction from the bank server that can be displayed to the user (e.g. \"Enter TAN\"), typically in the language of the bank's country. The order remains valid for execution for only a couple of minutes (the exact validity period depends on the bank). For executing the order, use the /executeSepaDirectDebit service after calling this service. Note that when the order is not executed within the validity period, the bank might take note of that and - if happening too often - ultimately lock the user's online banking access. If there already exists a previously submitted but not yet executed SEPA order for this account (either another direct debit order, or a money transfer order), then that order will be discarded and replaced with the new order that is being created with this service call.<br/><br/>Notes:<br/>&bull; This service cannot be used for the demo account.<br/>&bull; When using a two-step-procedure with flag 'implicitExecute' = true, then this service will immediately execute the direct debit. The response will not contain any challenge message and you won't be required to make a subsequent call to /executeSepaDirectDebit.

Parameters:

body - Parameters for a SEPA direct debit request (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

requestSepaMoneyTransferCall

public com.squareup.okhttp.Call requestSepaMoneyTransferCall(RequestSepaMoneyTransferParams body,
                                                             ProgressResponseBody.ProgressListener progressListener,
                                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                      throws ApiException

Build call for requestSepaMoneyTransfer

Parameters:

body - Parameters for a SEPA money transfer request (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

requestSepaMoneyTransfer

public MoneyTransferOrderingResponse requestSepaMoneyTransfer(RequestSepaMoneyTransferParams body)
                                                       throws ApiException

Request SEPA Money Transfer Submit a SEPA money transfer order for either a single or a collective money transfer. Returns an instruction from the bank server that can be displayed to the user (e.g. \"Enter TAN\"), typically in the language of the bank's country. The order remains valid for execution for only a couple of minutes (the exact validity period depends on the bank). For executing the order, use the /executeSepaMoneyTransfer service after calling this service. Note that when the order is not executed within the validity period, the bank might take note of that and - if happening too often - ultimately lock the user's online banking access. If there already exists a previously submitted but not yet executed SEPA order for this account (either another money transfer order, or a direct debit order), then that order will be discarded and replaced with the new order that is being created with this service call.<br/><br/>Notes:<br/>&bull; This service cannot be used for the demo account.<br/>&bull; Some banks may require a multi-step authentication, in which case the service will respond with HTTP code 510 and an error message containing a challenge for the user from the bank. You must display the challenge message to the user, and then retry the service call, passing the user's answer to the bank's challenge in the 'challengeResponse' field.<br/>&bull; When using a two-step-procedure with flag 'implicitExecute' = true, then this service will immediately execute the money transfer. The response will not contain any challenge message and you won't be required to make a subsequent call to /executeSepaMoneyTransfer.

Parameters:

body - Parameters for a SEPA money transfer request (required)

Returns:

MoneyTransferOrderingResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

requestSepaMoneyTransferWithHttpInfo

public ApiResponse<MoneyTransferOrderingResponse> requestSepaMoneyTransferWithHttpInfo(RequestSepaMoneyTransferParams body)
                                                                                throws ApiException

Request SEPA Money Transfer Submit a SEPA money transfer order for either a single or a collective money transfer. Returns an instruction from the bank server that can be displayed to the user (e.g. \"Enter TAN\"), typically in the language of the bank's country. The order remains valid for execution for only a couple of minutes (the exact validity period depends on the bank). For executing the order, use the /executeSepaMoneyTransfer service after calling this service. Note that when the order is not executed within the validity period, the bank might take note of that and - if happening too often - ultimately lock the user's online banking access. If there already exists a previously submitted but not yet executed SEPA order for this account (either another money transfer order, or a direct debit order), then that order will be discarded and replaced with the new order that is being created with this service call.<br/><br/>Notes:<br/>&bull; This service cannot be used for the demo account.<br/>&bull; Some banks may require a multi-step authentication, in which case the service will respond with HTTP code 510 and an error message containing a challenge for the user from the bank. You must display the challenge message to the user, and then retry the service call, passing the user's answer to the bank's challenge in the 'challengeResponse' field.<br/>&bull; When using a two-step-procedure with flag 'implicitExecute' = true, then this service will immediately execute the money transfer. The response will not contain any challenge message and you won't be required to make a subsequent call to /executeSepaMoneyTransfer.

Parameters:

body - Parameters for a SEPA money transfer request (required)

Returns:

ApiResponse<MoneyTransferOrderingResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

requestSepaMoneyTransferAsync

public com.squareup.okhttp.Call requestSepaMoneyTransferAsync(RequestSepaMoneyTransferParams body,
                                                              ApiCallback<MoneyTransferOrderingResponse> callback)
                                                       throws ApiException

Request SEPA Money Transfer (asynchronously) Submit a SEPA money transfer order for either a single or a collective money transfer. Returns an instruction from the bank server that can be displayed to the user (e.g. \"Enter TAN\"), typically in the language of the bank's country. The order remains valid for execution for only a couple of minutes (the exact validity period depends on the bank). For executing the order, use the /executeSepaMoneyTransfer service after calling this service. Note that when the order is not executed within the validity period, the bank might take note of that and - if happening too often - ultimately lock the user's online banking access. If there already exists a previously submitted but not yet executed SEPA order for this account (either another money transfer order, or a direct debit order), then that order will be discarded and replaced with the new order that is being created with this service call.<br/><br/>Notes:<br/>&bull; This service cannot be used for the demo account.<br/>&bull; Some banks may require a multi-step authentication, in which case the service will respond with HTTP code 510 and an error message containing a challenge for the user from the bank. You must display the challenge message to the user, and then retry the service call, passing the user's answer to the bank's challenge in the 'challengeResponse' field.<br/>&bull; When using a two-step-procedure with flag 'implicitExecute' = true, then this service will immediately execute the money transfer. The response will not contain any challenge message and you won't be required to make a subsequent call to /executeSepaMoneyTransfer.

Parameters:

body - Parameters for a SEPA money transfer request (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object