BankConnectionsApi (finapi-adapter 3.0.28 API)

java.lang.Object
- io.swagger.client.api.BankConnectionsApi

public class BankConnectionsApi
extends Object

Constructor Summary

Constructors
Constructor and Description

BankConnectionsApi()

BankConnectionsApi(ApiClient apiClient)

Constructors
Constructor and Description
`BankConnectionsApi()`
`BankConnectionsApi(ApiClient apiClient)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`IdentifierList`	`deleteAllBankConnections()` Delete all bank connections Delete all bank connections of the user that is authorized by the access_token.
`com.squareup.okhttp.Call`	`deleteAllBankConnectionsAsync(ApiCallback<IdentifierList> callback)` Delete all bank connections (asynchronously) Delete all bank connections of the user that is authorized by the access_token.
`com.squareup.okhttp.Call`	`deleteAllBankConnectionsCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for deleteAllBankConnections
`ApiResponse<IdentifierList>`	`deleteAllBankConnectionsWithHttpInfo()` Delete all bank connections Delete all bank connections of the user that is authorized by the access_token.
`void`	`deleteBankConnection(Long id)` Delete a bank connection Delete a single bank connection of the user that is authorized by the access_token, including all of its accounts and their transactions and balance data.
`com.squareup.okhttp.Call`	`deleteBankConnectionAsync(Long id, ApiCallback<Void> callback)` Delete a bank connection (asynchronously) Delete a single bank connection of the user that is authorized by the access_token, including all of its accounts and their transactions and balance data.
`com.squareup.okhttp.Call`	`deleteBankConnectionCall(Long id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for deleteBankConnection
`ApiResponse<Void>`	`deleteBankConnectionWithHttpInfo(Long id)` Delete a bank connection Delete a single bank connection of the user that is authorized by the access_token, including all of its accounts and their transactions and balance data.
`BankConnection`	`editBankConnection(Long id, EditBankConnectionParams body)` Edit a bank connection Change the stored authentication credentials (banking user ID, banking customer ID, and banking PIN), or other fields of the bank connection.
`com.squareup.okhttp.Call`	`editBankConnectionAsync(Long id, EditBankConnectionParams body, ApiCallback<BankConnection> callback)` Edit a bank connection (asynchronously) Change the stored authentication credentials (banking user ID, banking customer ID, and banking PIN), or other fields of the bank connection.
`com.squareup.okhttp.Call`	`editBankConnectionCall(Long id, EditBankConnectionParams body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for editBankConnection
`ApiResponse<BankConnection>`	`editBankConnectionWithHttpInfo(Long id, EditBankConnectionParams body)` Edit a bank connection Change the stored authentication credentials (banking user ID, banking customer ID, and banking PIN), or other fields of the bank connection.
`BankConnectionList`	`getAllBankConnections(List<Long> ids)` Get all bank connections Get bank connections of the user that is authorized by the access_token.
`com.squareup.okhttp.Call`	`getAllBankConnectionsAsync(List<Long> ids, ApiCallback<BankConnectionList> callback)` Get all bank connections (asynchronously) Get bank connections of the user that is authorized by the access_token.
`com.squareup.okhttp.Call`	`getAllBankConnectionsCall(List<Long> ids, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getAllBankConnections
`ApiResponse<BankConnectionList>`	`getAllBankConnectionsWithHttpInfo(List<Long> ids)` Get all bank connections Get bank connections of the user that is authorized by the access_token.
`ApiClient`	`getApiClient()`
`BankConnection`	`getBankConnection(Long id)` Get a bank connection Get a single bank connection of the user that is authorized by the access_token.
`com.squareup.okhttp.Call`	`getBankConnectionAsync(Long id, ApiCallback<BankConnection> callback)` Get a bank connection (asynchronously) Get a single bank connection of the user that is authorized by the access_token.
`com.squareup.okhttp.Call`	`getBankConnectionCall(Long id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getBankConnection
`ApiResponse<BankConnection>`	`getBankConnectionWithHttpInfo(Long id)` Get a bank connection Get a single bank connection of the user that is authorized by the access_token.
`BankConnectionList`	`getMultipleBankConnections(List<Long> ids)` Deprecated.
`com.squareup.okhttp.Call`	`getMultipleBankConnectionsAsync(List<Long> ids, ApiCallback<BankConnectionList> callback)` Deprecated.
`com.squareup.okhttp.Call`	`getMultipleBankConnectionsCall(List<Long> ids, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Deprecated.
`ApiResponse<BankConnectionList>`	`getMultipleBankConnectionsWithHttpInfo(List<Long> ids)` Deprecated.
`BankConnection`	`importBankConnection(ImportBankConnectionParams body)` Import a new bank connection Imports a new bank connection for a specific user.
`com.squareup.okhttp.Call`	`importBankConnectionAsync(ImportBankConnectionParams body, ApiCallback<BankConnection> callback)` Import a new bank connection (asynchronously) Imports a new bank connection for a specific user.
`com.squareup.okhttp.Call`	`importBankConnectionCall(ImportBankConnectionParams body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for importBankConnection
`ApiResponse<BankConnection>`	`importBankConnectionWithHttpInfo(ImportBankConnectionParams body)` Import a new bank connection Imports a new bank connection for a specific user.
`void`	`setApiClient(ApiClient apiClient)`
`BankConnection`	`updateBankConnection(UpdateBankConnectionParams body)` Update a bank connection Update an existing bank connection of the user that is authorized by the access_token.
`com.squareup.okhttp.Call`	`updateBankConnectionAsync(UpdateBankConnectionParams body, ApiCallback<BankConnection> callback)` Update a bank connection (asynchronously) Update an existing bank connection of the user that is authorized by the access_token.
`com.squareup.okhttp.Call`	`updateBankConnectionCall(UpdateBankConnectionParams body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for updateBankConnection
`ApiResponse<BankConnection>`	`updateBankConnectionWithHttpInfo(UpdateBankConnectionParams body)` Update a bank connection Update an existing bank connection of the user that is authorized by the access_token.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
 - BankConnectionsApi
```
public BankConnectionsApi()
```
 - BankConnectionsApi
```
public BankConnectionsApi(ApiClient apiClient)
```
- Method Detail
 - getApiClient
```
public ApiClient getApiClient()
```
 - setApiClient
```
public void setApiClient(ApiClient apiClient)
```
 - deleteAllBankConnectionsCall
```
public com.squareup.okhttp.Call deleteAllBankConnectionsCall(ProgressResponseBody.ProgressListener progressListener,
 ProgressRequestBody.ProgressRequestListener progressRequestListener)
 throws ApiException
```
 Build call for deleteAllBankConnections
 
 Parameters:
 
 progressListener - Progress listener
 
 progressRequestListener - Progress request listener
 
 Returns:
 
 Call to execute
 
 Throws:
 
 ApiException - If fail to serialize the request body object
 - deleteAllBankConnections
```
public IdentifierList deleteAllBankConnections()
 throws ApiException
```
 Delete all bank connections Delete all bank connections of the user that is authorized by the access_token. Must pass the user's access_token. Notes: - All notification rules that are connected to any specific bank connection will get deleted as well. - If at least one bank connection is busy (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
 - deleteAllBankConnectionsWithHttpInfo
```
public ApiResponse<IdentifierList> deleteAllBankConnectionsWithHttpInfo()
 throws ApiException
```
 Delete all bank connections Delete all bank connections of the user that is authorized by the access_token. Must pass the user's access_token. Notes: - All notification rules that are connected to any specific bank connection will get deleted as well. - If at least one bank connection is busy (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
 - deleteAllBankConnectionsAsync
```
public com.squareup.okhttp.Call deleteAllBankConnectionsAsync(ApiCallback<IdentifierList> callback)
 throws ApiException
```
 Delete all bank connections (asynchronously) Delete all bank connections of the user that is authorized by the access_token. Must pass the user's access_token. Notes: - All notification rules that are connected to any specific bank connection will get deleted as well. - If at least one bank connection is busy (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
 - deleteBankConnectionCall
```
public com.squareup.okhttp.Call deleteBankConnectionCall(Long id,
 ProgressResponseBody.ProgressListener progressListener,
 ProgressRequestBody.ProgressRequestListener progressRequestListener)
 throws ApiException
```
 Build call for deleteBankConnection
 
 Parameters:
 
 id - Identifier of the bank connection to delete (required)
 
 progressListener - Progress listener
 
 progressRequestListener - Progress request listener
 
 Returns:
 
 Call to execute
 
 Throws:
 
 ApiException - If fail to serialize the request body object
 - deleteBankConnection
```
public void deleteBankConnection(Long id)
 throws ApiException
```
 Delete a bank connection Delete a single bank connection of the user that is authorized by the access_token, including all of its accounts and their transactions and balance data. Must pass the connection's identifier and the user's access_token. Notes: - All notification rules that are connected to the bank connection will get adjusted so that they no longer have this connection listed. Notification rules that are connected to just this bank connection (and no other connection) will get deleted altogether. - A bank connection cannot get deleted while it is in the process of import, update, or transactions categorization.
 
 Parameters:
 
 id - Identifier of the bank connection to delete (required)
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 - deleteBankConnectionWithHttpInfo
```
public ApiResponse<Void> deleteBankConnectionWithHttpInfo(Long id)
 throws ApiException
```
 Delete a bank connection Delete a single bank connection of the user that is authorized by the access_token, including all of its accounts and their transactions and balance data. Must pass the connection's identifier and the user's access_token. Notes: - All notification rules that are connected to the bank connection will get adjusted so that they no longer have this connection listed. Notification rules that are connected to just this bank connection (and no other connection) will get deleted altogether. - A bank connection cannot get deleted while it is in the process of import, update, or transactions categorization.
 
 Parameters:
 
 id - Identifier of the bank connection to delete (required)
 
 Returns:
 
 ApiResponse<Void>
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 - deleteBankConnectionAsync
```
public com.squareup.okhttp.Call deleteBankConnectionAsync(Long id,
 ApiCallback<Void> callback)
 throws ApiException
```
 Delete a bank connection (asynchronously) Delete a single bank connection of the user that is authorized by the access_token, including all of its accounts and their transactions and balance data. Must pass the connection's identifier and the user's access_token. Notes: - All notification rules that are connected to the bank connection will get adjusted so that they no longer have this connection listed. Notification rules that are connected to just this bank connection (and no other connection) will get deleted altogether. - A bank connection cannot get deleted while it is in the process of import, update, or transactions categorization.
 
 Parameters:
 
 id - Identifier of the bank connection 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
 - editBankConnectionCall
```
public com.squareup.okhttp.Call editBankConnectionCall(Long id,
 EditBankConnectionParams body,
 ProgressResponseBody.ProgressListener progressListener,
 ProgressRequestBody.ProgressRequestListener progressRequestListener)
 throws ApiException
```
 Build call for editBankConnection
 
 Parameters:
 
 id - Identifier of the bank connection to change the parameters for (required)
 
 body - New bank connection parameters (required)
 
 progressListener - Progress listener
 
 progressRequestListener - Progress request listener
 
 Returns:
 
 Call to execute
 
 Throws:
 
 ApiException - If fail to serialize the request body object
 - editBankConnection
```
public BankConnection editBankConnection(Long id,
 EditBankConnectionParams body)
 throws ApiException
```
 Edit a bank connection Change the stored authentication credentials (banking user ID, banking customer ID, and banking PIN), or other fields of the bank connection. Must pass the connection's identifier and the user's access_token. Note that a bank connection's credentials cannot be changed while it is in the process of import, update, or transactions categorization.
 
 Parameters:
 
 id - Identifier of the bank connection to change the parameters for (required)
 
 body - New bank connection parameters (required)
 
 Returns:
 
 BankConnection
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 - editBankConnectionWithHttpInfo
```
public ApiResponse<BankConnection> editBankConnectionWithHttpInfo(Long id,
 EditBankConnectionParams body)
 throws ApiException
```
 Edit a bank connection Change the stored authentication credentials (banking user ID, banking customer ID, and banking PIN), or other fields of the bank connection. Must pass the connection's identifier and the user's access_token. Note that a bank connection's credentials cannot be changed while it is in the process of import, update, or transactions categorization.
 
 Parameters:
 
 id - Identifier of the bank connection to change the parameters for (required)
 
 body - New bank connection parameters (required)
 
 Returns:
 
 ApiResponse<BankConnection>
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 - editBankConnectionAsync
```
public com.squareup.okhttp.Call editBankConnectionAsync(Long id,
 EditBankConnectionParams body,
 ApiCallback<BankConnection> callback)
 throws ApiException
```
 Edit a bank connection (asynchronously) Change the stored authentication credentials (banking user ID, banking customer ID, and banking PIN), or other fields of the bank connection. Must pass the connection's identifier and the user's access_token. Note that a bank connection's credentials cannot be changed while it is in the process of import, update, or transactions categorization.
 
 Parameters:
 
 id - Identifier of the bank connection to change the parameters for (required)
 
 body - New bank connection parameters (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
 - getAllBankConnectionsCall
```
public com.squareup.okhttp.Call getAllBankConnectionsCall(List<Long> ids,
 ProgressResponseBody.ProgressListener progressListener,
 ProgressRequestBody.ProgressRequestListener progressRequestListener)
 throws ApiException
```
 Build call for getAllBankConnections
 
 Parameters:
 
 ids - A comma-separated list of bank connection identifiers. If specified, then only bank connections whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)
 
 progressListener - Progress listener
 
 progressRequestListener - Progress request listener
 
 Returns:
 
 Call to execute
 
 Throws:
 
 ApiException - If fail to serialize the request body object
 - getAllBankConnections
```
public BankConnectionList getAllBankConnections(List<Long> ids)
 throws ApiException
```
 Get all bank connections Get bank connections 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 connections 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 bank connection identifiers. If specified, then only bank connections whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)
 
 Returns:
 
 BankConnectionList
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 - getAllBankConnectionsWithHttpInfo
```
public ApiResponse<BankConnectionList> getAllBankConnectionsWithHttpInfo(List<Long> ids)
 throws ApiException
```
 Get all bank connections Get bank connections 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 connections 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 bank connection identifiers. If specified, then only bank connections whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)
 
 Returns:
 
 ApiResponse<BankConnectionList>
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 - getAllBankConnectionsAsync
```
public com.squareup.okhttp.Call getAllBankConnectionsAsync(List<Long> ids,
 ApiCallback<BankConnectionList> callback)
 throws ApiException
```
 Get all bank connections (asynchronously) Get bank connections 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 connections 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 bank connection identifiers. If specified, then only bank connections whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (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
 - getBankConnectionCall
```
public com.squareup.okhttp.Call getBankConnectionCall(Long id,
 ProgressResponseBody.ProgressListener progressListener,
 ProgressRequestBody.ProgressRequestListener progressRequestListener)
 throws ApiException
```
 Build call for getBankConnection
 
 Parameters:
 
 id - Identifier of requested bank connection (required)
 
 progressListener - Progress listener
 
 progressRequestListener - Progress request listener
 
 Returns:
 
 Call to execute
 
 Throws:
 
 ApiException - If fail to serialize the request body object
 - getBankConnection
```
public BankConnection getBankConnection(Long id)
 throws ApiException
```
 Get a bank connection Get a single bank connection of the user that is authorized by the access_token. Must pass the connection's identifier and the user's access_token.
 
 Parameters:
 
 id - Identifier of requested bank connection (required)
 
 Returns:
 
 BankConnection
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 - getBankConnectionWithHttpInfo
```
public ApiResponse<BankConnection> getBankConnectionWithHttpInfo(Long id)
 throws ApiException
```
 Get a bank connection Get a single bank connection of the user that is authorized by the access_token. Must pass the connection's identifier and the user's access_token.
 
 Parameters:
 
 id - Identifier of requested bank connection (required)
 
 Returns:
 
 ApiResponse<BankConnection>
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 - getBankConnectionAsync
```
public com.squareup.okhttp.Call getBankConnectionAsync(Long id,
 ApiCallback<BankConnection> callback)
 throws ApiException
```
 Get a bank connection (asynchronously) Get a single bank connection of the user that is authorized by the access_token. Must pass the connection's identifier and the user's access_token.
 
 Parameters:
 
 id - Identifier of requested bank connection (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
 - getMultipleBankConnectionsCall
```
@Deprecated
public com.squareup.okhttp.Call getMultipleBankConnectionsCall(List<Long> ids,
 ProgressResponseBody.ProgressListener progressListener,
 ProgressRequestBody.ProgressRequestListener progressRequestListener)
 throws ApiException
```
 Deprecated.
 
 Build call for getMultipleBankConnections
 
 Parameters:
 
 ids - Comma-separated list of identifiers of requested bank connections (required)
 
 progressListener - Progress listener
 
 progressRequestListener - Progress request listener
 
 Returns:
 
 Call to execute
 
 Throws:
 
 ApiException - If fail to serialize the request body object
 - getMultipleBankConnections
```
@Deprecated
public BankConnectionList getMultipleBankConnections(List<Long> ids)
 throws ApiException
```
 Deprecated.
 
 Get multiple bank connections Get a list of multiple bank connections of the user that is authorized by the access_token. Must pass the connections' identifiers and the user's access_token. Connections 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 bank connections, please instead use the service 'Get all bank connections' and pass a comma-separated list of identifiers as a parameter 'ids'.
 
 Parameters:
 
 ids - Comma-separated list of identifiers of requested bank connections (required)
 
 Returns:
 
 BankConnectionList
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 - getMultipleBankConnectionsWithHttpInfo
```
@Deprecated
public ApiResponse<BankConnectionList> getMultipleBankConnectionsWithHttpInfo(List<Long> ids)
 throws ApiException
```
 Deprecated.
 
 Get multiple bank connections Get a list of multiple bank connections of the user that is authorized by the access_token. Must pass the connections' identifiers and the user's access_token. Connections 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 bank connections, please instead use the service 'Get all bank connections' and pass a comma-separated list of identifiers as a parameter 'ids'.
 
 Parameters:
 
 ids - Comma-separated list of identifiers of requested bank connections (required)
 
 Returns:
 
 ApiResponse<BankConnectionList>
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 - getMultipleBankConnectionsAsync
```
@Deprecated
public com.squareup.okhttp.Call getMultipleBankConnectionsAsync(List<Long> ids,
 ApiCallback<BankConnectionList> callback)
 throws ApiException
```
 Deprecated.
 
 Get multiple bank connections (asynchronously) Get a list of multiple bank connections of the user that is authorized by the access_token. Must pass the connections' identifiers and the user's access_token. Connections 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 bank connections, please instead use the service 'Get all bank connections' and pass a comma-separated list of identifiers as a parameter 'ids'.
 
 Parameters:
 
 ids - Comma-separated list of identifiers of requested bank connections (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
 - importBankConnectionCall
```
public com.squareup.okhttp.Call importBankConnectionCall(ImportBankConnectionParams body,
 ProgressResponseBody.ProgressListener progressListener,
 ProgressRequestBody.ProgressRequestListener progressRequestListener)
 throws ApiException
```
 Build call for importBankConnection
 
 Parameters:
 
 body - Import bank connection parameters (required)
 
 progressListener - Progress listener
 
 progressRequestListener - Progress request listener
 
 Returns:
 
 Call to execute
 
 Throws:
 
 ApiException - If fail to serialize the request body object
 - importBankConnection
```
public BankConnection importBankConnection(ImportBankConnectionParams body)
 throws ApiException
```
 Import a new bank connection Imports a new bank connection for a specific user. Must pass the connection credentials and the user's access_token. All bank accounts will be downloaded and imported with their current balances, transactions and supported two-step procedures (note that the amount of available transactions may vary between banks, e.g. some banks deliver all transactions from the past year, others only deliver the transactions from the past three months). The balance and transactions download process runs asynchronously, so this service may return before all balances and transactions have been imported. Also, all downloaded transactions will be categorized by a separate background process that runs asynchronously too. To check the status of the balance and transactions download process as well as the background categorization process, see the status flags that are returned by the GET /bankConnections/<id> service. Note that 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. You can also import a \"demo connection\" which contains a single bank account with some pre-defined transactions. To import the demo connection, you need to pass the identifier of the \"demo bank\", which is a bank with BLZ 00000000 (see GET /banks/search). In case of demo connection import, any other fields besides the demo bank identifier can remain unset. The bankingUserId, bankingPin, and storePin fields will be stored, however they will generally not be relevant when updating the bank connection. Also, the skipPositionsDownload flag is ignored for the demo bank connection, i.e. when importing the demo bank connection, you will always get the transactions for its account. You can enable multi-step authentication for the demo bank connection by setting the bank connection name to \"MSA\". For a more in-depth understanding of the import process, please also read this article on our Dev Portal: <a href='https://finapi.zendesk.com/hc/en-us/articles/115000296607-Import-Update-of-Bank-Connections-Accounts'>Import & Update of Bank Connections / Accounts</a>
 
 Parameters:
 
 body - Import bank connection parameters (required)
 
 Returns:
 
 BankConnection
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 - importBankConnectionWithHttpInfo
```
public ApiResponse<BankConnection> importBankConnectionWithHttpInfo(ImportBankConnectionParams body)
 throws ApiException
```
 Import a new bank connection Imports a new bank connection for a specific user. Must pass the connection credentials and the user's access_token. All bank accounts will be downloaded and imported with their current balances, transactions and supported two-step procedures (note that the amount of available transactions may vary between banks, e.g. some banks deliver all transactions from the past year, others only deliver the transactions from the past three months). The balance and transactions download process runs asynchronously, so this service may return before all balances and transactions have been imported. Also, all downloaded transactions will be categorized by a separate background process that runs asynchronously too. To check the status of the balance and transactions download process as well as the background categorization process, see the status flags that are returned by the GET /bankConnections/<id> service. Note that 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. You can also import a \"demo connection\" which contains a single bank account with some pre-defined transactions. To import the demo connection, you need to pass the identifier of the \"demo bank\", which is a bank with BLZ 00000000 (see GET /banks/search). In case of demo connection import, any other fields besides the demo bank identifier can remain unset. The bankingUserId, bankingPin, and storePin fields will be stored, however they will generally not be relevant when updating the bank connection. Also, the skipPositionsDownload flag is ignored for the demo bank connection, i.e. when importing the demo bank connection, you will always get the transactions for its account. You can enable multi-step authentication for the demo bank connection by setting the bank connection name to \"MSA\". For a more in-depth understanding of the import process, please also read this article on our Dev Portal: <a href='https://finapi.zendesk.com/hc/en-us/articles/115000296607-Import-Update-of-Bank-Connections-Accounts'>Import & Update of Bank Connections / Accounts</a>
 
 Parameters:
 
 body - Import bank connection parameters (required)
 
 Returns:
 
 ApiResponse<BankConnection>
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 - importBankConnectionAsync
```
public com.squareup.okhttp.Call importBankConnectionAsync(ImportBankConnectionParams body,
 ApiCallback<BankConnection> callback)
 throws ApiException
```
 Import a new bank connection (asynchronously) Imports a new bank connection for a specific user. Must pass the connection credentials and the user's access_token. All bank accounts will be downloaded and imported with their current balances, transactions and supported two-step procedures (note that the amount of available transactions may vary between banks, e.g. some banks deliver all transactions from the past year, others only deliver the transactions from the past three months). The balance and transactions download process runs asynchronously, so this service may return before all balances and transactions have been imported. Also, all downloaded transactions will be categorized by a separate background process that runs asynchronously too. To check the status of the balance and transactions download process as well as the background categorization process, see the status flags that are returned by the GET /bankConnections/<id> service. Note that 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. You can also import a \"demo connection\" which contains a single bank account with some pre-defined transactions. To import the demo connection, you need to pass the identifier of the \"demo bank\", which is a bank with BLZ 00000000 (see GET /banks/search). In case of demo connection import, any other fields besides the demo bank identifier can remain unset. The bankingUserId, bankingPin, and storePin fields will be stored, however they will generally not be relevant when updating the bank connection. Also, the skipPositionsDownload flag is ignored for the demo bank connection, i.e. when importing the demo bank connection, you will always get the transactions for its account. You can enable multi-step authentication for the demo bank connection by setting the bank connection name to \"MSA\". For a more in-depth understanding of the import process, please also read this article on our Dev Portal: <a href='https://finapi.zendesk.com/hc/en-us/articles/115000296607-Import-Update-of-Bank-Connections-Accounts'>Import & Update of Bank Connections / Accounts</a>
 
 Parameters:
 
 body - Import bank connection parameters (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
 - updateBankConnectionCall
```
public com.squareup.okhttp.Call updateBankConnectionCall(UpdateBankConnectionParams body,
 ProgressResponseBody.ProgressListener progressListener,
 ProgressRequestBody.ProgressRequestListener progressRequestListener)
 throws ApiException
```
 Build call for updateBankConnection
 
 Parameters:
 
 body - Update bank connection parameters (required)
 
 progressListener - Progress listener
 
 progressRequestListener - Progress request listener
 
 Returns:
 
 Call to execute
 
 Throws:
 
 ApiException - If fail to serialize the request body object
 - updateBankConnection
```
public BankConnection updateBankConnection(UpdateBankConnectionParams body)
 throws ApiException
```
 Update a bank connection Update an existing bank connection of the user that is authorized by the access_token. Downloads and imports the current account balances and new transactions. Must pass the connection's identifier and the user's access_token. For more information about the processes of authentication, data download and transactions categorization, see POST /bankConnections/import. Note that supported two-step procedures are updated as well. It may unset the current default two-step procedure of the given bank connection (but only if this procedure is not supported anymore by the bank). You can also update the \"demo connection\" (in this case, the fields 'bankingPin', 'importNewAccounts', and 'skipPositionsDownload' will be ignored). Note that you cannot trigger an update of a bank connection as long as there is still a previously triggered update running. For a more in-depth understanding of the update process, please also read this article on our Dev Portal: <a href='https://finapi.zendesk.com/hc/en-us/articles/115000296607-Import-Update-of-Bank-Connections-Accounts'>Import & Update of Bank Connections / Accounts</a>
 
 Parameters:
 
 body - Update bank connection parameters (required)
 
 Returns:
 
 BankConnection
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 - updateBankConnectionWithHttpInfo
```
public ApiResponse<BankConnection> updateBankConnectionWithHttpInfo(UpdateBankConnectionParams body)
 throws ApiException
```
 Update a bank connection Update an existing bank connection of the user that is authorized by the access_token. Downloads and imports the current account balances and new transactions. Must pass the connection's identifier and the user's access_token. For more information about the processes of authentication, data download and transactions categorization, see POST /bankConnections/import. Note that supported two-step procedures are updated as well. It may unset the current default two-step procedure of the given bank connection (but only if this procedure is not supported anymore by the bank). You can also update the \"demo connection\" (in this case, the fields 'bankingPin', 'importNewAccounts', and 'skipPositionsDownload' will be ignored). Note that you cannot trigger an update of a bank connection as long as there is still a previously triggered update running. For a more in-depth understanding of the update process, please also read this article on our Dev Portal: <a href='https://finapi.zendesk.com/hc/en-us/articles/115000296607-Import-Update-of-Bank-Connections-Accounts'>Import & Update of Bank Connections / Accounts</a>
 
 Parameters:
 
 body - Update bank connection parameters (required)
 
 Returns:
 
 ApiResponse<BankConnection>
 
 Throws:
 
 ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
 - updateBankConnectionAsync
```
public com.squareup.okhttp.Call updateBankConnectionAsync(UpdateBankConnectionParams body,
 ApiCallback<BankConnection> callback)
 throws ApiException
```
 Update a bank connection (asynchronously) Update an existing bank connection of the user that is authorized by the access_token. Downloads and imports the current account balances and new transactions. Must pass the connection's identifier and the user's access_token. For more information about the processes of authentication, data download and transactions categorization, see POST /bankConnections/import. Note that supported two-step procedures are updated as well. It may unset the current default two-step procedure of the given bank connection (but only if this procedure is not supported anymore by the bank). You can also update the \"demo connection\" (in this case, the fields 'bankingPin', 'importNewAccounts', and 'skipPositionsDownload' will be ignored). Note that you cannot trigger an update of a bank connection as long as there is still a previously triggered update running. For a more in-depth understanding of the update process, please also read this article on our Dev Portal: <a href='https://finapi.zendesk.com/hc/en-us/articles/115000296607-Import-Update-of-Bank-Connections-Accounts'>Import & Update of Bank Connections / Accounts</a>
 
 Parameters:
 
 body - Update bank connection parameters (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

Class BankConnectionsApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BankConnectionsApi

BankConnectionsApi

Method Detail

getApiClient

setApiClient

deleteAllBankConnectionsCall

deleteAllBankConnections

deleteAllBankConnectionsWithHttpInfo

deleteAllBankConnectionsAsync

deleteBankConnectionCall

deleteBankConnection

deleteBankConnectionWithHttpInfo

deleteBankConnectionAsync

editBankConnectionCall

editBankConnection

editBankConnectionWithHttpInfo

editBankConnectionAsync

getAllBankConnectionsCall

getAllBankConnections

getAllBankConnectionsWithHttpInfo

getAllBankConnectionsAsync

getBankConnectionCall

getBankConnection

getBankConnectionWithHttpInfo

getBankConnectionAsync

getMultipleBankConnectionsCall

getMultipleBankConnections

getMultipleBankConnectionsWithHttpInfo

getMultipleBankConnectionsAsync

importBankConnectionCall

importBankConnection

importBankConnectionWithHttpInfo

importBankConnectionAsync

updateBankConnectionCall

updateBankConnection

updateBankConnectionWithHttpInfo

updateBankConnectionAsync