| Name | Type | Description | Notes |
|---|---|---|---|
| Id | int64 | Bank identifier.<br/><br/>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. | |
| Name | string | Name of bank | |
| LoginHint | NullableString | THIS FIELD IS DEPRECATED AND WILL BE REMOVED.<br/>Please refer to the 'loginHint' field in the 'interfaces' instead.<br/><br/>Login hint. Contains a German message for the user that explains what kind of credentials are expected.<br/><br/>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.<br/><br/>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. | |
| Bic | NullableString | BIC of bank | |
| Blzs | []string | ||
| Blz | string | BLZ of bank | |
| Location | NullableString | 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. | |
| City | NullableString | City that this bank is located in. Note that this field may not be set for some banks. | |
| IsSupported | bool | THIS FIELD IS DEPRECATED AND WILL BE REMOVED.<br/>Please refer to the 'isMoneyTransferSupported' and 'isAisSupported' fields in the 'interfaces' instead.<br/><br/>Whether this bank is supported by finAPI, i.e. whether you can import/update a bank connection of this bank.<br/><br/>NOTE: this field only regards FINTS_SERVER and WEB_SCRAPER interfaces. XS2A is not considered. | |
| IsTestBank | bool | 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. | |
| Popularity | int32 | 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'). | |
| Health | int32 | THIS FIELD IS DEPRECATED AND WILL BE REMOVED.<br/>Please refer to the 'health' field in the 'interfaces' instead. <br/><br/>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. | |
| LoginFieldUserId | NullableString | THIS FIELD IS DEPRECATED AND WILL BE REMOVED.<br/>Please refer to the 'loginCredentials' in the 'interfaces' instead.<br/><br/>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. | |
| LoginFieldCustomerId | NullableString | THIS FIELD IS DEPRECATED AND WILL BE REMOVED.<br/>Please refer to the 'loginCredentials' in the 'interfaces' instead.<br/><br/>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. | |
| LoginFieldPin | NullableString | THIS FIELD IS DEPRECATED AND WILL BE REMOVED.<br/>Please refer to the 'loginCredentials' in the 'interfaces' instead.<br/><br/>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. | |
| PinsAreVolatile | bool | THIS FIELD IS DEPRECATED AND WILL BE REMOVED.<br/>Please refer to the 'isVolatile' field of the 'loginCredentials' in the 'interfaces' instead.<br/><br/>Whether the PINs that are used for authentication with the bank are volatile. If the PINs are volatile, it means that the value for the field, which is provided by the user, is valid only for a single authentication and then gets invalidated on bank-side. If pinsAreVolatile is true, it is not possible to store the PIN in finAPI, as a stored PIN will never work for future authentications. | |
| IsCustomerIdPassword | bool | THIS FIELD IS DEPRECATED AND WILL BE REMOVED.<br/>Please refer to the 'isSecret' field of the 'loginCredentials' in 'interfaces' instead.<br/><br/>Whether the banking customer ID has to be treated like a password. Certain banks require a second password (besides the PIN) for the user to login. In this case your application should use a password input field when prompting users for their credentials. | |
| SupportedDataSources | []SupportedDataSource | ||
| Interfaces | []BankInterface | <strong>Type:</strong> BankInterface<br/> Set of interfaces that finAPI can use to connect to the bank. Note that this set will be empty for non-supported banks. Note also that the WEB_SCRAPER interface 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 interface 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). | |
| BankGroup | NullableBankGroup | <strong>Type:</strong> BankGroup<br/> Bank group | |
| LastCommunicationAttempt | NullableString | THIS FIELD IS DEPRECATED AND WILL BE REMOVED.<br/>Please refer to the 'lastCommunicationAttempt' field in the 'interfaces' instead. <br/><br/>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). | |
| LastSuccessfulCommunication | NullableString | THIS FIELD IS DEPRECATED AND WILL BE REMOVED.<br/>Please refer to the 'lastSuccessfulCommunication' field in the 'interfaces' instead. <br/><br/>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). | |
| IsBeta | bool | Whether this bank is in beta phase. For more details, please refer to the field ClientConfiguration.betaBanksEnabled. |
func NewBank(id int64, name string, loginHint NullableString, bic NullableString, blzs []string, blz string, location NullableString, city NullableString, isSupported bool, isTestBank bool, popularity int32, health int32, loginFieldUserId NullableString, loginFieldCustomerId NullableString, loginFieldPin NullableString, pinsAreVolatile bool, isCustomerIdPassword bool, supportedDataSources []SupportedDataSource, interfaces []BankInterface, bankGroup NullableBankGroup, lastCommunicationAttempt NullableString, lastSuccessfulCommunication NullableString, isBeta bool, ) *Bank
NewBank instantiates a new Bank object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed
func NewBankWithDefaults() *Bank
NewBankWithDefaults instantiates a new Bank object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set
func (o *Bank) GetId() int64
GetId returns the Id field if non-nil, zero value otherwise.
func (o *Bank) GetIdOk() (*int64, bool)
GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetId(v int64)
SetId sets Id field to given value.
func (o *Bank) GetName() string
GetName returns the Name field if non-nil, zero value otherwise.
func (o *Bank) GetNameOk() (*string, bool)
GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetName(v string)
SetName sets Name field to given value.
func (o *Bank) GetLoginHint() string
GetLoginHint returns the LoginHint field if non-nil, zero value otherwise.
func (o *Bank) GetLoginHintOk() (*string, bool)
GetLoginHintOk returns a tuple with the LoginHint field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetLoginHint(v string)
SetLoginHint sets LoginHint field to given value.
func (o *Bank) SetLoginHintNil(b bool)
SetLoginHintNil sets the value for LoginHint to be an explicit nil
func (o *Bank) UnsetLoginHint()
UnsetLoginHint ensures that no value is present for LoginHint, not even an explicit nil
func (o *Bank) GetBic() string
GetBic returns the Bic field if non-nil, zero value otherwise.
func (o *Bank) GetBicOk() (*string, bool)
GetBicOk returns a tuple with the Bic field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetBic(v string)
SetBic sets Bic field to given value.
func (o *Bank) SetBicNil(b bool)
SetBicNil sets the value for Bic to be an explicit nil
func (o *Bank) UnsetBic()
UnsetBic ensures that no value is present for Bic, not even an explicit nil
func (o *Bank) GetBlzs() []string
GetBlzs returns the Blzs field if non-nil, zero value otherwise.
func (o *Bank) GetBlzsOk() (*[]string, bool)
GetBlzsOk returns a tuple with the Blzs field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetBlzs(v []string)
SetBlzs sets Blzs field to given value.
func (o *Bank) GetBlz() string
GetBlz returns the Blz field if non-nil, zero value otherwise.
func (o *Bank) GetBlzOk() (*string, bool)
GetBlzOk returns a tuple with the Blz field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetBlz(v string)
SetBlz sets Blz field to given value.
func (o *Bank) GetLocation() string
GetLocation returns the Location field if non-nil, zero value otherwise.
func (o *Bank) GetLocationOk() (*string, bool)
GetLocationOk returns a tuple with the Location field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetLocation(v string)
SetLocation sets Location field to given value.
func (o *Bank) SetLocationNil(b bool)
SetLocationNil sets the value for Location to be an explicit nil
func (o *Bank) UnsetLocation()
UnsetLocation ensures that no value is present for Location, not even an explicit nil
func (o *Bank) GetCity() string
GetCity returns the City field if non-nil, zero value otherwise.
func (o *Bank) GetCityOk() (*string, bool)
GetCityOk returns a tuple with the City field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetCity(v string)
SetCity sets City field to given value.
func (o *Bank) SetCityNil(b bool)
SetCityNil sets the value for City to be an explicit nil
func (o *Bank) UnsetCity()
UnsetCity ensures that no value is present for City, not even an explicit nil
func (o *Bank) GetIsSupported() bool
GetIsSupported returns the IsSupported field if non-nil, zero value otherwise.
func (o *Bank) GetIsSupportedOk() (*bool, bool)
GetIsSupportedOk returns a tuple with the IsSupported field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetIsSupported(v bool)
SetIsSupported sets IsSupported field to given value.
func (o *Bank) GetIsTestBank() bool
GetIsTestBank returns the IsTestBank field if non-nil, zero value otherwise.
func (o *Bank) GetIsTestBankOk() (*bool, bool)
GetIsTestBankOk returns a tuple with the IsTestBank field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetIsTestBank(v bool)
SetIsTestBank sets IsTestBank field to given value.
func (o *Bank) GetPopularity() int32
GetPopularity returns the Popularity field if non-nil, zero value otherwise.
func (o *Bank) GetPopularityOk() (*int32, bool)
GetPopularityOk returns a tuple with the Popularity field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetPopularity(v int32)
SetPopularity sets Popularity field to given value.
func (o *Bank) GetHealth() int32
GetHealth returns the Health field if non-nil, zero value otherwise.
func (o *Bank) GetHealthOk() (*int32, bool)
GetHealthOk returns a tuple with the Health field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetHealth(v int32)
SetHealth sets Health field to given value.
func (o *Bank) GetLoginFieldUserId() string
GetLoginFieldUserId returns the LoginFieldUserId field if non-nil, zero value otherwise.
func (o *Bank) GetLoginFieldUserIdOk() (*string, bool)
GetLoginFieldUserIdOk returns a tuple with the LoginFieldUserId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetLoginFieldUserId(v string)
SetLoginFieldUserId sets LoginFieldUserId field to given value.
func (o *Bank) SetLoginFieldUserIdNil(b bool)
SetLoginFieldUserIdNil sets the value for LoginFieldUserId to be an explicit nil
func (o *Bank) UnsetLoginFieldUserId()
UnsetLoginFieldUserId ensures that no value is present for LoginFieldUserId, not even an explicit nil
func (o *Bank) GetLoginFieldCustomerId() string
GetLoginFieldCustomerId returns the LoginFieldCustomerId field if non-nil, zero value otherwise.
func (o *Bank) GetLoginFieldCustomerIdOk() (*string, bool)
GetLoginFieldCustomerIdOk returns a tuple with the LoginFieldCustomerId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetLoginFieldCustomerId(v string)
SetLoginFieldCustomerId sets LoginFieldCustomerId field to given value.
func (o *Bank) SetLoginFieldCustomerIdNil(b bool)
SetLoginFieldCustomerIdNil sets the value for LoginFieldCustomerId to be an explicit nil
func (o *Bank) UnsetLoginFieldCustomerId()
UnsetLoginFieldCustomerId ensures that no value is present for LoginFieldCustomerId, not even an explicit nil
func (o *Bank) GetLoginFieldPin() string
GetLoginFieldPin returns the LoginFieldPin field if non-nil, zero value otherwise.
func (o *Bank) GetLoginFieldPinOk() (*string, bool)
GetLoginFieldPinOk returns a tuple with the LoginFieldPin field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetLoginFieldPin(v string)
SetLoginFieldPin sets LoginFieldPin field to given value.
func (o *Bank) SetLoginFieldPinNil(b bool)
SetLoginFieldPinNil sets the value for LoginFieldPin to be an explicit nil
func (o *Bank) UnsetLoginFieldPin()
UnsetLoginFieldPin ensures that no value is present for LoginFieldPin, not even an explicit nil
func (o *Bank) GetPinsAreVolatile() bool
GetPinsAreVolatile returns the PinsAreVolatile field if non-nil, zero value otherwise.
func (o *Bank) GetPinsAreVolatileOk() (*bool, bool)
GetPinsAreVolatileOk returns a tuple with the PinsAreVolatile field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetPinsAreVolatile(v bool)
SetPinsAreVolatile sets PinsAreVolatile field to given value.
func (o *Bank) GetIsCustomerIdPassword() bool
GetIsCustomerIdPassword returns the IsCustomerIdPassword field if non-nil, zero value otherwise.
func (o *Bank) GetIsCustomerIdPasswordOk() (*bool, bool)
GetIsCustomerIdPasswordOk returns a tuple with the IsCustomerIdPassword field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetIsCustomerIdPassword(v bool)
SetIsCustomerIdPassword sets IsCustomerIdPassword field to given value.
func (o *Bank) GetSupportedDataSources() []SupportedDataSource
GetSupportedDataSources returns the SupportedDataSources field if non-nil, zero value otherwise.
func (o *Bank) GetSupportedDataSourcesOk() (*[]SupportedDataSource, bool)
GetSupportedDataSourcesOk returns a tuple with the SupportedDataSources field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetSupportedDataSources(v []SupportedDataSource)
SetSupportedDataSources sets SupportedDataSources field to given value.
func (o *Bank) GetInterfaces() []BankInterface
GetInterfaces returns the Interfaces field if non-nil, zero value otherwise.
func (o *Bank) GetInterfacesOk() (*[]BankInterface, bool)
GetInterfacesOk returns a tuple with the Interfaces field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetInterfaces(v []BankInterface)
SetInterfaces sets Interfaces field to given value.
func (o *Bank) GetBankGroup() BankGroup
GetBankGroup returns the BankGroup field if non-nil, zero value otherwise.
func (o *Bank) GetBankGroupOk() (*BankGroup, bool)
GetBankGroupOk returns a tuple with the BankGroup field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetBankGroup(v BankGroup)
SetBankGroup sets BankGroup field to given value.
func (o *Bank) SetBankGroupNil(b bool)
SetBankGroupNil sets the value for BankGroup to be an explicit nil
func (o *Bank) UnsetBankGroup()
UnsetBankGroup ensures that no value is present for BankGroup, not even an explicit nil
func (o *Bank) GetLastCommunicationAttempt() string
GetLastCommunicationAttempt returns the LastCommunicationAttempt field if non-nil, zero value otherwise.
func (o *Bank) GetLastCommunicationAttemptOk() (*string, bool)
GetLastCommunicationAttemptOk returns a tuple with the LastCommunicationAttempt field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetLastCommunicationAttempt(v string)
SetLastCommunicationAttempt sets LastCommunicationAttempt field to given value.
func (o *Bank) SetLastCommunicationAttemptNil(b bool)
SetLastCommunicationAttemptNil sets the value for LastCommunicationAttempt to be an explicit nil
func (o *Bank) UnsetLastCommunicationAttempt()
UnsetLastCommunicationAttempt ensures that no value is present for LastCommunicationAttempt, not even an explicit nil
func (o *Bank) GetLastSuccessfulCommunication() string
GetLastSuccessfulCommunication returns the LastSuccessfulCommunication field if non-nil, zero value otherwise.
func (o *Bank) GetLastSuccessfulCommunicationOk() (*string, bool)
GetLastSuccessfulCommunicationOk returns a tuple with the LastSuccessfulCommunication field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetLastSuccessfulCommunication(v string)
SetLastSuccessfulCommunication sets LastSuccessfulCommunication field to given value.
func (o *Bank) SetLastSuccessfulCommunicationNil(b bool)
SetLastSuccessfulCommunicationNil sets the value for LastSuccessfulCommunication to be an explicit nil
func (o *Bank) UnsetLastSuccessfulCommunication()
UnsetLastSuccessfulCommunication ensures that no value is present for LastSuccessfulCommunication, not even an explicit nil
func (o *Bank) GetIsBeta() bool
GetIsBeta returns the IsBeta field if non-nil, zero value otherwise.
func (o *Bank) GetIsBetaOk() (*bool, bool)
GetIsBetaOk returns a tuple with the IsBeta field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *Bank) SetIsBeta(v bool)
SetIsBeta sets IsBeta field to given value.