io.swagger.client.api

Class BanksApi

java.lang.Object

io.swagger.client.api.BanksApi

public class BanksApi
extends Object

Constructor Summary

Constructors

Constructor and Description
BanksApi()
BanksApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
PageableBankList	getAndSearchAllBanks(List<Long> ids, String search, Boolean isSupported, Boolean pinsAreVolatile, List<String> supportedDataSources, List<String> location, Boolean isTestBank, Integer page, Integer perPage, List<String> order) Get and search all banks Get and search banks from finAPI's database of banks.
com.squareup.okhttp.Call	getAndSearchAllBanksAsync(List<Long> ids, String search, Boolean isSupported, Boolean pinsAreVolatile, List<String> supportedDataSources, List<String> location, Boolean isTestBank, Integer page, Integer perPage, List<String> order, ApiCallback<PageableBankList> callback) Get and search all banks (asynchronously) Get and search banks from finAPI's database of banks.
com.squareup.okhttp.Call	getAndSearchAllBanksCall(List<Long> ids, String search, Boolean isSupported, Boolean pinsAreVolatile, List<String> supportedDataSources, List<String> location, Boolean isTestBank, Integer page, Integer perPage, List<String> order, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAndSearchAllBanks
ApiResponse<PageableBankList>	getAndSearchAllBanksWithHttpInfo(List<Long> ids, String search, Boolean isSupported, Boolean pinsAreVolatile, List<String> supportedDataSources, List<String> location, Boolean isTestBank, Integer page, Integer perPage, List<String> order) Get and search all banks Get and search banks from finAPI's database of banks.
ApiClient	getApiClient()
Bank	getBank(Long id) Get a bank Get a single bank from finAPI's database of banks.
com.squareup.okhttp.Call	getBankAsync(Long id, ApiCallback<Bank> callback) Get a bank (asynchronously) Get a single bank from finAPI's database of banks.
com.squareup.okhttp.Call	getBankCall(Long id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getBank
ApiResponse<Bank>	getBankWithHttpInfo(Long id) Get a bank Get a single bank from finAPI's database of banks.
BankList	getMultipleBanks(List<Long> ids) Deprecated.
com.squareup.okhttp.Call	getMultipleBanksAsync(List<Long> ids, ApiCallback<BankList> callback) Deprecated.
com.squareup.okhttp.Call	getMultipleBanksCall(List<Long> ids, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Deprecated.
ApiResponse<BankList>	getMultipleBanksWithHttpInfo(List<Long> ids) Deprecated.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

BanksApi

public BanksApi()

BanksApi

public BanksApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAndSearchAllBanksCall

public com.squareup.okhttp.Call getAndSearchAllBanksCall(List<Long> ids,
                                                         String search,
                                                         Boolean isSupported,
                                                         Boolean pinsAreVolatile,
                                                         List<String> supportedDataSources,
                                                         List<String> location,
                                                         Boolean isTestBank,
                                                         Integer page,
                                                         Integer perPage,
                                                         List<String> order,
                                                         ProgressResponseBody.ProgressListener progressListener,
                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                  throws ApiException

Build call for getAndSearchAllBanks

Parameters:

ids - A comma-separated list of bank identifiers. If specified, then only banks 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 banks will be contained in the result whose 'name', 'blz', 'bic' or 'city' contains the given search string (the matching works case-insensitive). If no banks contain the search string in any of the regarded fields, then the result will be an empty list. Note that you may also pass an IBAN in this field, in which case finAPI will try to find the related bank in its database and regard only this bank for the search. Also note: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must apply to a bank in order for it to get included into the result. (optional)

isSupported - If specified, then only supported (in case of 'true' value) or unsupported (in case of 'false' value) banks will be regarded. (optional)

pinsAreVolatile - If specified, then only those banks will be regarded that have the given value (true or false) for their 'pinsAreVolatile' field. (optional)

supportedDataSources - Comma-separated list of data sources. Possible values: WEB_SCRAPER,FINTS_SERVER. If this parameter is specified, then only those banks will be regarded in the search that support ALL of the given data sources. Note that this does NOT imply that those data sources must be the only data sources that are supported by a bank. (optional)

location - Comma-separated list of two-letter country codes (ISO 3166 ALPHA-2). If set, then only those banks will be regarded in the search that are located in the specified countries. Notes: Banks which do not have a location set (i.e. international institutes) will ALWAYS be regarded in the search, independent of what you specify for this field. When you pass a country code that doesn't exist in the ISO 3166 ALPHA-2 standard, then the service will respond with 400 BAD_REQUEST. (optional)

isTestBank - If specified, then only those banks will be regarded that have the given value (true or false) for their 'isTestBank' field. (optional)

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 'id', 'name', 'blz', 'bic' or 'popularity'. The default order for all services is 'id,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. Example: '/banks?order=name,desc&order=id,asc' will return banks ordered by 'name' (descending), where banks with the same 'name' are ordered by 'id' (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

getAndSearchAllBanks

public PageableBankList getAndSearchAllBanks(List<Long> ids,
                                             String search,
                                             Boolean isSupported,
                                             Boolean pinsAreVolatile,
                                             List<String> supportedDataSources,
                                             List<String> location,
                                             Boolean isTestBank,
                                             Integer page,
                                             Integer perPage,
                                             List<String> order)
                                      throws ApiException

Get and search all banks Get and search banks from finAPI's database of banks. Must pass the authorized user's access_token, or your client's access_token. You can set optional search criteria to get only those banks 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 identifiers. If specified, then only banks 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 banks will be contained in the result whose 'name', 'blz', 'bic' or 'city' contains the given search string (the matching works case-insensitive). If no banks contain the search string in any of the regarded fields, then the result will be an empty list. Note that you may also pass an IBAN in this field, in which case finAPI will try to find the related bank in its database and regard only this bank for the search. Also note: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must apply to a bank in order for it to get included into the result. (optional)

isSupported - If specified, then only supported (in case of 'true' value) or unsupported (in case of 'false' value) banks will be regarded. (optional)

pinsAreVolatile - If specified, then only those banks will be regarded that have the given value (true or false) for their 'pinsAreVolatile' field. (optional)

supportedDataSources - Comma-separated list of data sources. Possible values: WEB_SCRAPER,FINTS_SERVER. If this parameter is specified, then only those banks will be regarded in the search that support ALL of the given data sources. Note that this does NOT imply that those data sources must be the only data sources that are supported by a bank. (optional)

location - Comma-separated list of two-letter country codes (ISO 3166 ALPHA-2). If set, then only those banks will be regarded in the search that are located in the specified countries. Notes: Banks which do not have a location set (i.e. international institutes) will ALWAYS be regarded in the search, independent of what you specify for this field. When you pass a country code that doesn't exist in the ISO 3166 ALPHA-2 standard, then the service will respond with 400 BAD_REQUEST. (optional)

isTestBank - If specified, then only those banks will be regarded that have the given value (true or false) for their 'isTestBank' field. (optional)

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 'id', 'name', 'blz', 'bic' or 'popularity'. The default order for all services is 'id,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. Example: '/banks?order=name,desc&order=id,asc' will return banks ordered by 'name' (descending), where banks with the same 'name' are ordered by 'id' (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:

PageableBankList

Throws:

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

getAndSearchAllBanksWithHttpInfo

public ApiResponse<PageableBankList> getAndSearchAllBanksWithHttpInfo(List<Long> ids,
                                                                      String search,
                                                                      Boolean isSupported,
                                                                      Boolean pinsAreVolatile,
                                                                      List<String> supportedDataSources,
                                                                      List<String> location,
                                                                      Boolean isTestBank,
                                                                      Integer page,
                                                                      Integer perPage,
                                                                      List<String> order)
                                                               throws ApiException

Get and search all banks Get and search banks from finAPI's database of banks. Must pass the authorized user's access_token, or your client's access_token. You can set optional search criteria to get only those banks 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 identifiers. If specified, then only banks 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 banks will be contained in the result whose 'name', 'blz', 'bic' or 'city' contains the given search string (the matching works case-insensitive). If no banks contain the search string in any of the regarded fields, then the result will be an empty list. Note that you may also pass an IBAN in this field, in which case finAPI will try to find the related bank in its database and regard only this bank for the search. Also note: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must apply to a bank in order for it to get included into the result. (optional)

isSupported - If specified, then only supported (in case of 'true' value) or unsupported (in case of 'false' value) banks will be regarded. (optional)

pinsAreVolatile - If specified, then only those banks will be regarded that have the given value (true or false) for their 'pinsAreVolatile' field. (optional)

supportedDataSources - Comma-separated list of data sources. Possible values: WEB_SCRAPER,FINTS_SERVER. If this parameter is specified, then only those banks will be regarded in the search that support ALL of the given data sources. Note that this does NOT imply that those data sources must be the only data sources that are supported by a bank. (optional)

location - Comma-separated list of two-letter country codes (ISO 3166 ALPHA-2). If set, then only those banks will be regarded in the search that are located in the specified countries. Notes: Banks which do not have a location set (i.e. international institutes) will ALWAYS be regarded in the search, independent of what you specify for this field. When you pass a country code that doesn't exist in the ISO 3166 ALPHA-2 standard, then the service will respond with 400 BAD_REQUEST. (optional)

isTestBank - If specified, then only those banks will be regarded that have the given value (true or false) for their 'isTestBank' field. (optional)

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 'id', 'name', 'blz', 'bic' or 'popularity'. The default order for all services is 'id,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. Example: '/banks?order=name,desc&order=id,asc' will return banks ordered by 'name' (descending), where banks with the same 'name' are ordered by 'id' (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<PageableBankList>

Throws:

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

getAndSearchAllBanksAsync

public com.squareup.okhttp.Call getAndSearchAllBanksAsync(List<Long> ids,
                                                          String search,
                                                          Boolean isSupported,
                                                          Boolean pinsAreVolatile,
                                                          List<String> supportedDataSources,
                                                          List<String> location,
                                                          Boolean isTestBank,
                                                          Integer page,
                                                          Integer perPage,
                                                          List<String> order,
                                                          ApiCallback<PageableBankList> callback)
                                                   throws ApiException

Get and search all banks (asynchronously) Get and search banks from finAPI's database of banks. Must pass the authorized user's access_token, or your client's access_token. You can set optional search criteria to get only those banks 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 identifiers. If specified, then only banks 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 banks will be contained in the result whose 'name', 'blz', 'bic' or 'city' contains the given search string (the matching works case-insensitive). If no banks contain the search string in any of the regarded fields, then the result will be an empty list. Note that you may also pass an IBAN in this field, in which case finAPI will try to find the related bank in its database and regard only this bank for the search. Also note: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must apply to a bank in order for it to get included into the result. (optional)

isSupported - If specified, then only supported (in case of 'true' value) or unsupported (in case of 'false' value) banks will be regarded. (optional)

pinsAreVolatile - If specified, then only those banks will be regarded that have the given value (true or false) for their 'pinsAreVolatile' field. (optional)

supportedDataSources - Comma-separated list of data sources. Possible values: WEB_SCRAPER,FINTS_SERVER. If this parameter is specified, then only those banks will be regarded in the search that support ALL of the given data sources. Note that this does NOT imply that those data sources must be the only data sources that are supported by a bank. (optional)

location - Comma-separated list of two-letter country codes (ISO 3166 ALPHA-2). If set, then only those banks will be regarded in the search that are located in the specified countries. Notes: Banks which do not have a location set (i.e. international institutes) will ALWAYS be regarded in the search, independent of what you specify for this field. When you pass a country code that doesn't exist in the ISO 3166 ALPHA-2 standard, then the service will respond with 400 BAD_REQUEST. (optional)

isTestBank - If specified, then only those banks will be regarded that have the given value (true or false) for their 'isTestBank' field. (optional)

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 'id', 'name', 'blz', 'bic' or 'popularity'. The default order for all services is 'id,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. Example: '/banks?order=name,desc&order=id,asc' will return banks ordered by 'name' (descending), where banks with the same 'name' are ordered by 'id' (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

getBankCall

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

Build call for getBank

Parameters:

id - Identifier of requested bank (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getBank

public Bank getBank(Long id)
             throws ApiException

Get a bank Get a single bank from finAPI's database of banks. You have to pass the bank's identifier, and either the authorized user's access_token, or your client's access token.

Parameters:

id - Identifier of requested bank (required)

Returns:

Bank

Throws:

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

getBankWithHttpInfo

public ApiResponse<Bank> getBankWithHttpInfo(Long id)
                                      throws ApiException

Get a bank Get a single bank from finAPI's database of banks. You have to pass the bank's identifier, and either the authorized user's access_token, or your client's access token.

Parameters:

id - Identifier of requested bank (required)

Returns:

ApiResponse<Bank>

Throws:

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

getBankAsync

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

Get a bank (asynchronously) Get a single bank from finAPI's database of banks. You have to pass the bank's identifier, and either the authorized user's access_token, or your client's access token.

Parameters:

id - Identifier of requested bank (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

getMultipleBanksCall

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

Deprecated.

Build call for getMultipleBanks

Parameters:

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getMultipleBanks

@Deprecated
public BankList getMultipleBanks(List<Long> ids)
                                      throws ApiException

Deprecated.

Get multiple banks Get a list of multiple banks from finAPI's database of banks. You have to pass a list of bank identifiers, and either the authorized user's access_token, or your client's access token. Note that banks whose identifiers do not exist will not be contained in the result (If this applies to all of the given identifiers, then the result will be an empty list).<br/><br/><b>WARNING</b>: This service is deprecated and will be removed at some point. If you want to get multiple banks, please instead use the service 'Get and search all banks' and pass a comma-separated list of identifiers with the parameter 'ids'.

Parameters:

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

Returns:

BankList

Throws:

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

getMultipleBanksWithHttpInfo

@Deprecated
public ApiResponse<BankList> getMultipleBanksWithHttpInfo(List<Long> ids)
                                                               throws ApiException

Deprecated.

Get multiple banks Get a list of multiple banks from finAPI's database of banks. You have to pass a list of bank identifiers, and either the authorized user's access_token, or your client's access token. Note that banks whose identifiers do not exist will not be contained in the result (If this applies to all of the given identifiers, then the result will be an empty list).<br/><br/><b>WARNING</b>: This service is deprecated and will be removed at some point. If you want to get multiple banks, please instead use the service 'Get and search all banks' and pass a comma-separated list of identifiers with the parameter 'ids'.

Parameters:

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

Returns:

ApiResponse<BankList>

Throws:

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

getMultipleBanksAsync

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

Deprecated.

Get multiple banks (asynchronously) Get a list of multiple banks from finAPI's database of banks. You have to pass a list of bank identifiers, and either the authorized user's access_token, or your client's access token. Note that banks whose identifiers do not exist will not be contained in the result (If this applies to all of the given identifiers, then the result will be an empty list).<br/><br/><b>WARNING</b>: This service is deprecated and will be removed at some point. If you want to get multiple banks, please instead use the service 'Get and search all banks' and pass a comma-separated list of identifiers with the parameter 'ids'.

Parameters:

ids - Comma-separated list of identifiers of requested banks (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