Bank (finapi-adapter 3.0.28 API)

java.lang.Object
- io.swagger.client.model.Bank

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2018-05-14T19:12:52.919Z")
public class Bank
extends Object

Container for a bank's data

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Bank.SupportedDataSourcesEnum
Gets or Sets supportedDataSources

Nested Classes
Modifier and Type	Class and Description
`static class`	`Bank.SupportedDataSourcesEnum` Gets or Sets supportedDataSources

Constructor Summary

Constructors
Constructor and Description

Bank()

Constructors
Constructor and Description
`Bank()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Bank`	`addBlzsItem(String blzsItem)`
`Bank`	`addSupportedDataSourcesItem(Bank.SupportedDataSourcesEnum supportedDataSourcesItem)`
`Bank`	`bic(String bic)`
`Bank`	`blz(String blz)`
`Bank`	`blzs(List<String> blzs)`
`Bank`	`city(String city)`
`boolean`	`equals(Object o)`
`String`	`getBic()` BIC of bank
`String`	`getBlz()` BLZ of bank
`List<String>`	`getBlzs()` List of BLZs that belong to this bank.
`String`	`getCity()` City that this bank is located in.
`Integer`	`getHealth()` The health status of this bank.
`Long`	`getId()` Bank identifier.<br/><br/>NOTE: Do NOT assume that the identifiers of banks are the same across different finAPI environments.
`String`	`getLastCommunicationAttempt()` Time of the last communication attempt with this bank during a bank connection import or update (across the entire finAPI system).
`String`	`getLastSuccessfulCommunication()` Time of the last successful communication with this bank during a bank connection import or update (across the entire finAPI system).
`String`	`getLocation()` Bank location (two-letter country code; ISO 3166 ALPHA-2).
`String`	`getLoginFieldCustomerId()` Label for the customer ID login field, as it is called on the bank's website (e.g.
`String`	`getLoginFieldPin()` Label for the PIN field, as it is called on the bank's website (mostly \"PIN\").
`String`	`getLoginFieldUserId()` Label for the user ID login field, as it is called on the bank's website (e.g.
`String`	`getLoginHint()` Login hint.
`String`	`getName()` Name of bank
`Integer`	`getPopularity()` Popularity of this bank with your users (mandator-wide, i.e.
`List<Bank.SupportedDataSourcesEnum>`	`getSupportedDataSources()` List of the data sources that finAPI will use for data download for this bank.
`int`	`hashCode()`
`Bank`	`health(Integer health)`
`Bank`	`id(Long id)`
`Boolean`	`isIsSupported()` Whether this bank is supported by finAPI, i.e.
`Boolean`	`isIsTestBank()` If true, then this bank does not depict a real bank, but rather a testing endpoint provided by a bank or by finAPI.
`Boolean`	`isPinsAreVolatile()` Whether the PINs that are used for authentication with the bank are volatile.
`Bank`	`isSupported(Boolean isSupported)`
`Bank`	`isTestBank(Boolean isTestBank)`
`Bank`	`lastCommunicationAttempt(String lastCommunicationAttempt)`
`Bank`	`lastSuccessfulCommunication(String lastSuccessfulCommunication)`
`Bank`	`location(String location)`
`Bank`	`loginFieldCustomerId(String loginFieldCustomerId)`
`Bank`	`loginFieldPin(String loginFieldPin)`
`Bank`	`loginFieldUserId(String loginFieldUserId)`
`Bank`	`loginHint(String loginHint)`
`Bank`	`name(String name)`
`Bank`	`pinsAreVolatile(Boolean pinsAreVolatile)`
`Bank`	`popularity(Integer popularity)`
`void`	`setBic(String bic)`
`void`	`setBlz(String blz)`
`void`	`setBlzs(List<String> blzs)`
`void`	`setCity(String city)`
`void`	`setHealth(Integer health)`
`void`	`setId(Long id)`
`void`	`setIsSupported(Boolean isSupported)`
`void`	`setIsTestBank(Boolean isTestBank)`
`void`	`setLastCommunicationAttempt(String lastCommunicationAttempt)`
`void`	`setLastSuccessfulCommunication(String lastSuccessfulCommunication)`
`void`	`setLocation(String location)`
`void`	`setLoginFieldCustomerId(String loginFieldCustomerId)`
`void`	`setLoginFieldPin(String loginFieldPin)`
`void`	`setLoginFieldUserId(String loginFieldUserId)`
`void`	`setLoginHint(String loginHint)`
`void`	`setName(String name)`
`void`	`setPinsAreVolatile(Boolean pinsAreVolatile)`
`void`	`setPopularity(Integer popularity)`
`void`	`setSupportedDataSources(List<Bank.SupportedDataSourcesEnum> supportedDataSources)`
`Bank`	`supportedDataSources(List<Bank.SupportedDataSourcesEnum> supportedDataSources)`
`String`	`toString()`

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

- Constructor Detail
 - Bank
```
public Bank()
```
- Method Detail
 - id
```
public Bank id(Long id)
```
 - getId
```
public Long getId()
```
 Bank identifier. NOTE: Do NOT assume that the identifiers of banks are the same across different finAPI environments. In fact, the identifiers may change whenever a new finAPI version is released, even within the same environment. The identifiers are meant to be used for references within the finAPI services only, but not for hard-coding them in your application. If you need to hard-code the usage of a certain bank within your application, please instead refer to the BLZ.
 
 Returns:
 
 id
 - setId
```
public void setId(Long id)
```
 - name
```
public Bank name(String name)
```
 - getName
```
public String getName()
```
 Name of bank
 
 Returns:
 
 name
 - setName
```
public void setName(String name)
```
 - loginHint
```
public Bank loginHint(String loginHint)
```
 - getLoginHint
```
public String getLoginHint()
```
 Login hint. Contains a German message for the user that explains what kind of credentials are expected. Please note that it is strongly recommended to always show the login hint to the user if there is one, as the credentials that finAPI requires for the bank might be different to the credentials that the user knows from the bank's website. Also note that the contents of this field should always be interpreted as HTML, as the text might contain HTML tags for highlighted words, paragraphs, etc.
 
 Returns:
 
 loginHint
 - setLoginHint
```
public void setLoginHint(String loginHint)
```
 - bic
```
public Bank bic(String bic)
```
 - getBic
```
public String getBic()
```
 BIC of bank
 
 Returns:
 
 bic
 - setBic
```
public void setBic(String bic)
```
 - blz
```
public Bank blz(String blz)
```
 - getBlz
```
public String getBlz()
```
 BLZ of bank
 
 Returns:
 
 blz
 - setBlz
```
public void setBlz(String blz)
```
 - blzs
```
public Bank blzs(List<String> blzs)
```
 - addBlzsItem
```
public Bank addBlzsItem(String blzsItem)
```
 - getBlzs
```
public List<String> getBlzs()
```
 List of BLZs that belong to this bank. NOTE: This field is deprecated and will be removed at some point. Please refer to field 'blz' instead.
 
 Returns:
 
 blzs
 - setBlzs
```
public void setBlzs(List<String> blzs)
```
 - loginFieldUserId
```
public Bank loginFieldUserId(String loginFieldUserId)
```
 - getLoginFieldUserId
```
public String getLoginFieldUserId()
```
 Label for the user ID login field, as it is called on the bank's website (e.g. \"Nutzerkennung\"). If this field is set (i.e. not null) then you should prompt your users to enter the required data in a text field which you can label with this field's value.
 
 Returns:
 
 loginFieldUserId
 - setLoginFieldUserId
```
public void setLoginFieldUserId(String loginFieldUserId)
```
 - loginFieldCustomerId
```
public Bank loginFieldCustomerId(String loginFieldCustomerId)
```
 - getLoginFieldCustomerId
```
public String getLoginFieldCustomerId()
```
 Label for the customer ID login field, as it is called on the bank's website (e.g. \"Kundennummer\"). If this field is set (i.e. not null) then you should prompt your users to enter the required data in a text field which you can label with this field's value.
 
 Returns:
 
 loginFieldCustomerId
 - setLoginFieldCustomerId
```
public void setLoginFieldCustomerId(String loginFieldCustomerId)
```
 - loginFieldPin
```
public Bank loginFieldPin(String loginFieldPin)
```
 - getLoginFieldPin
```
public String getLoginFieldPin()
```
 Label for the PIN field, as it is called on the bank's website (mostly \"PIN\"). If this field is set (i.e. not null) then you should prompt your users to enter the required data in a text field which you can label with this field's value.
 
 Returns:
 
 loginFieldPin
 - setLoginFieldPin
```
public void setLoginFieldPin(String loginFieldPin)
```
 - isSupported
```
public Bank isSupported(Boolean isSupported)
```
 - isIsSupported
```
public Boolean isIsSupported()
```
 Whether this bank is supported by finAPI, i.e. whether you can import/update a bank connection of this bank.
 
 Returns:
 
 isSupported
 - setIsSupported
```
public void setIsSupported(Boolean isSupported)
```
 - supportedDataSources
```
public Bank supportedDataSources(List<Bank.SupportedDataSourcesEnum> supportedDataSources)
```
 - addSupportedDataSourcesItem
```
public Bank addSupportedDataSourcesItem(Bank.SupportedDataSourcesEnum supportedDataSourcesItem)
```
 - getSupportedDataSources
```
public List<Bank.SupportedDataSourcesEnum> getSupportedDataSources()
```
 List of the data sources that finAPI will use for data download for this bank. Possible values:• <code>FINTS_SERVER</code> - means that finAPI will download data via the bank's FinTS interface.• <code>WEB_SCRAPER</code> - means that finAPI will parse data from the bank's online banking website.Note that this list will be empty for non-supported banks. Note also that web scraping might be disabled for your client (see GET /clientConfiguration). When this is the case, then finAPI will not use the web scraper for data download, and if the web scraper is the only supported data source of this bank, then finAPI will not allow to download any data for this bank at all (for details, see POST /bankConnections/import and POST /bankConnections/update).
 
 Returns:
 
 supportedDataSources
 - setSupportedDataSources
```
public void setSupportedDataSources(List<Bank.SupportedDataSourcesEnum> supportedDataSources)
```
 - pinsAreVolatile
```
public Bank pinsAreVolatile(Boolean pinsAreVolatile)
```
 - isPinsAreVolatile
```
public Boolean isPinsAreVolatile()
```
 Whether the PINs that are used for authentication with the bank are volatile. If the PINs are volatile, it means that a PIN is usually valid only for a single authentication, and is then invalidated. If a bank uses volatile PINs, it is strongly inadvisable to store PINs in finAPI, as a stored PIN will not work for future authentications.
 
 Returns:
 
 pinsAreVolatile
 - setPinsAreVolatile
```
public void setPinsAreVolatile(Boolean pinsAreVolatile)
```
 - location
```
public Bank location(String location)
```
 - getLocation
```
public String getLocation()
```
 Bank location (two-letter country code; ISO 3166 ALPHA-2). Note that when this field is not set, it means that this bank depicts an international institute which is not bound to any specific country.
 
 Returns:
 
 location
 - setLocation
```
public void setLocation(String location)
```
 - city
```
public Bank city(String city)
```
 - getCity
```
public String getCity()
```
 City that this bank is located in. Note that this field may not be set for some banks.
 
 Returns:
 
 city
 - setCity
```
public void setCity(String city)
```
 - isTestBank
```
public Bank isTestBank(Boolean isTestBank)
```
 - isIsTestBank
```
public Boolean isIsTestBank()
```
 If true, then this bank does not depict a real bank, but rather a testing endpoint provided by a bank or by finAPI. You probably want to regard these banks only during the development of your application, but not in production. You can filter out these banks in production by making sure that the 'isTestBank' parameter is always set to 'false' whenever your application is calling the 'Get and search all banks' service.
 
 Returns:
 
 isTestBank
 - setIsTestBank
```
public void setIsTestBank(Boolean isTestBank)
```
 - popularity
```
public Bank popularity(Integer popularity)
```
 - getPopularity
```
public Integer getPopularity()
```
 Popularity of this bank with your users (mandator-wide, i.e. across all of your clients). The value equals the number of bank connections that are currently imported for this bank across all of your users (which means it is a constantly adjusting value). You can use this field for statistical evaluation, and also for ordering bank search results (see service 'Get and search all banks').
 
 Returns:
 
 popularity
 - setPopularity
```
public void setPopularity(Integer popularity)
```
 - health
```
public Bank health(Integer health)
```
 - getHealth
```
public Integer getHealth()
```
 The health status of this bank. This is a value between 0 and 100, depicting the percentage of successful communication attempts with this bank during the latest couple of bank connection imports or updates (across the entire finAPI system). Note that 'successful' means that there was no technical error trying to establish a communication with the bank. Non-technical errors (like incorrect credentials) are regarded successful communication attempts. minimum: 0 maximum: 100
 
 Returns:
 
 health
 - setHealth
```
public void setHealth(Integer health)
```
 - lastCommunicationAttempt
```
public Bank lastCommunicationAttempt(String lastCommunicationAttempt)
```
 - getLastCommunicationAttempt
```
public String getLastCommunicationAttempt()
```
 Time of the last communication attempt with this bank during a bank connection import or update (across the entire finAPI system). The value is returned in the format 'yyyy-MM-dd HH:mm:ss.SSS' (german time).
 
 Returns:
 
 lastCommunicationAttempt
 - setLastCommunicationAttempt
```
public void setLastCommunicationAttempt(String lastCommunicationAttempt)
```
 - lastSuccessfulCommunication
```
public Bank lastSuccessfulCommunication(String lastSuccessfulCommunication)
```
 - getLastSuccessfulCommunication
```
public String getLastSuccessfulCommunication()
```
 Time of the last successful communication with this bank during a bank connection import or update (across the entire finAPI system). The value is returned in the format 'yyyy-MM-dd HH:mm:ss.SSS' (german time).
 
 Returns:
 
 lastSuccessfulCommunication
 - setLastSuccessfulCommunication
```
public void setLastSuccessfulCommunication(String lastSuccessfulCommunication)
```
 - equals
```
public boolean equals(Object o)
```
 Overrides:
 
 equals in class Object
 - hashCode
```
public int hashCode()
```
 Overrides:
 
 hashCode in class Object
 - toString
```
public String toString()
```
 Overrides:
 
 toString in class Object

Class Bank

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Bank

Method Detail

id

getId

setId

name

getName

setName

loginHint

getLoginHint

setLoginHint

bic

getBic

setBic

blz

getBlz

setBlz

blzs

addBlzsItem

getBlzs

setBlzs

loginFieldUserId

getLoginFieldUserId

setLoginFieldUserId

loginFieldCustomerId

getLoginFieldCustomerId

setLoginFieldCustomerId

loginFieldPin

getLoginFieldPin

setLoginFieldPin

isSupported

isIsSupported

setIsSupported

supportedDataSources

addSupportedDataSourcesItem

getSupportedDataSources

setSupportedDataSources

pinsAreVolatile

isPinsAreVolatile

setPinsAreVolatile

location

getLocation

setLocation

city

getCity

setCity

isTestBank

isIsTestBank

setIsTestBank

popularity

getPopularity

setPopularity

health

getHealth

setHealth

lastCommunicationAttempt

getLastCommunicationAttempt

setLastCommunicationAttempt

lastSuccessfulCommunication

getLastSuccessfulCommunication

setLastSuccessfulCommunication

equals

hashCode

toString