ImportBankConnectionParams (finapi-adapter 3.0.28 API)

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

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

Container for bank connection import parameters

Constructor Summary

Constructors
Constructor and Description

ImportBankConnectionParams()

Constructors
Constructor and Description
`ImportBankConnectionParams()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImportBankConnectionParams`	`accountTypeIds(List<Long> accountTypeIds)`
`ImportBankConnectionParams`	`addAccountTypeIdsItem(Long accountTypeIdsItem)`
`ImportBankConnectionParams`	`bankId(Long bankId)`
`ImportBankConnectionParams`	`bankingCustomerId(String bankingCustomerId)`
`ImportBankConnectionParams`	`bankingPin(String bankingPin)`
`ImportBankConnectionParams`	`bankingUserId(String bankingUserId)`
`ImportBankConnectionParams`	`challengeResponse(String challengeResponse)`
`boolean`	`equals(Object o)`
`List<Long>`	`getAccountTypeIds()` Whitelist of identifiers of finAPI account types that are considered for the import.
`Long`	`getBankId()` Bank Identifier
`String`	`getBankingCustomerId()` Online banking customer ID credential (for most banks this field can remain unset).
`String`	`getBankingPin()` Online banking PIN.
`String`	`getBankingUserId()` Online banking user ID credential.
`String`	`getChallengeResponse()` Challenge response.
`Integer`	`getMaxDaysForDownload()` Use this parameter if you want to limit the date range for transactions download.
`String`	`getName()` Custom name for the bank connection.
`int`	`hashCode()`
`Boolean`	`isLoadOwnerData()` Whether to load information about the bank connection owner(s) - see field 'owners'.
`Boolean`	`isSkipPositionsDownload()` Whether to skip the download of transactions and securities or not.
`Boolean`	`isStorePin()` Whether to store the PIN.
`ImportBankConnectionParams`	`loadOwnerData(Boolean loadOwnerData)`
`ImportBankConnectionParams`	`maxDaysForDownload(Integer maxDaysForDownload)`
`ImportBankConnectionParams`	`name(String name)`
`void`	`setAccountTypeIds(List<Long> accountTypeIds)`
`void`	`setBankId(Long bankId)`
`void`	`setBankingCustomerId(String bankingCustomerId)`
`void`	`setBankingPin(String bankingPin)`
`void`	`setBankingUserId(String bankingUserId)`
`void`	`setChallengeResponse(String challengeResponse)`
`void`	`setLoadOwnerData(Boolean loadOwnerData)`
`void`	`setMaxDaysForDownload(Integer maxDaysForDownload)`
`void`	`setName(String name)`
`void`	`setSkipPositionsDownload(Boolean skipPositionsDownload)`
`void`	`setStorePin(Boolean storePin)`
`ImportBankConnectionParams`	`skipPositionsDownload(Boolean skipPositionsDownload)`
`ImportBankConnectionParams`	`storePin(Boolean storePin)`
`String`	`toString()`

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

- Constructor Detail
 - ImportBankConnectionParams
```
public ImportBankConnectionParams()
```
- Method Detail
 - bankId
```
public ImportBankConnectionParams bankId(Long bankId)
```
 - getBankId
```
public Long getBankId()
```
 Bank Identifier
 
 Returns:
 
 bankId
 - setBankId
```
public void setBankId(Long bankId)
```
 - bankingUserId
```
public ImportBankConnectionParams bankingUserId(String bankingUserId)
```
 - getBankingUserId
```
public String getBankingUserId()
```
 Online banking user ID credential. When importing the 'demo connection', you may leave this field unset. Max length: 64.
 
 Returns:
 
 bankingUserId
 - setBankingUserId
```
public void setBankingUserId(String bankingUserId)
```
 - bankingCustomerId
```
public ImportBankConnectionParams bankingCustomerId(String bankingCustomerId)
```
 - getBankingCustomerId
```
public String getBankingCustomerId()
```
 Online banking customer ID credential (for most banks this field can remain unset). Max length: 64.
 
 Returns:
 
 bankingCustomerId
 - setBankingCustomerId
```
public void setBankingCustomerId(String bankingCustomerId)
```
 - bankingPin
```
public ImportBankConnectionParams bankingPin(String bankingPin)
```
 - getBankingPin
```
public String getBankingPin()
```
 Online banking PIN. When importing the 'demo connection', you may leave this field unset. Any symbols are allowed. Max length: 170.
 
 Returns:
 
 bankingPin
 - setBankingPin
```
public void setBankingPin(String bankingPin)
```
 - storePin
```
public ImportBankConnectionParams storePin(Boolean storePin)
```
 - isStorePin
```
public Boolean isStorePin()
```
 Whether to store the PIN. If the PIN is stored, it is not required to pass the PIN again when updating this bank connection or executing orders (like money transfers). Default is false. NOTE: Before you set this field to true, please regard the 'pinsAreVolatile' flag of this connection's bank.
 
 Returns:
 
 storePin
 - setStorePin
```
public void setStorePin(Boolean storePin)
```
 - name
```
public ImportBankConnectionParams name(String name)
```
 - getName
```
public String getName()
```
 Custom name for the bank connection. Maximum length is 64. If you do not want to set a name, you can leave this field unset.
 
 Returns:
 
 name
 - setName
```
public void setName(String name)
```
 - skipPositionsDownload
```
public ImportBankConnectionParams skipPositionsDownload(Boolean skipPositionsDownload)
```
 - isSkipPositionsDownload
```
public Boolean isSkipPositionsDownload()
```
 Whether to skip the download of transactions and securities or not. If set to true, then finAPI will download just the accounts list with the accounts' information (like account name, number, holder, etc), as well as the accounts' balances (if possible), but skip the download of transactions and securities. Default is false. NOTES: • If you skip the download of transactions and securities during an import or update, you can still download them on a later update (though you might not get all positions at a later point, because the date range in which the bank servers provide this data is usually limited). However, once finAPI has downloaded the transactions or securities for the first time, you will not be able to go back to skipping the download of transactions and securities! In other words: Once you make your first request with skipPositionsDownload=false for a certain bank connection, you will no longer be able to make a request with skipPositionsDownload=true for that same bank connection. • If this bank connection is updated via finAPI's automatic batch update, then transactions and security positions will be downloaded in any case! • For security accounts, skipping the downloading of the securities might result in the account's balance also not being downloaded. • For Bausparen accounts, this field is ignored. finAPI will always download transactions for Bausparen accounts. This flag is currently not guaranteed to work for non-German banks!
 
 Returns:
 
 skipPositionsDownload
 - setSkipPositionsDownload
```
public void setSkipPositionsDownload(Boolean skipPositionsDownload)
```
 - loadOwnerData
```
public ImportBankConnectionParams loadOwnerData(Boolean loadOwnerData)
```
 - isLoadOwnerData
```
public Boolean isLoadOwnerData()
```
 Whether to load information about the bank connection owner(s) - see field 'owners'. Default value is 'false'.
 
 Returns:
 
 loadOwnerData
 - setLoadOwnerData
```
public void setLoadOwnerData(Boolean loadOwnerData)
```
 - maxDaysForDownload
```
public ImportBankConnectionParams maxDaysForDownload(Integer maxDaysForDownload)
```
 - getMaxDaysForDownload
```
public Integer getMaxDaysForDownload()
```
 Use this parameter if you want to limit the date range for transactions download. The value depicts the number of days that finAPI will download transactions for, starting from - and including - today. For example, if you want to download only transactions from within the past 30 days (including today), then pass the value 30. The minimum allowed value is 14, the maximum value is 3650. You may also pass the value 0 though (which is also the default value when you do not specify this parameter), in which case there will be no limit to the transactions download and finAPI will try to get all transactions that it can. Please note that when you specify the parameter there is no guarantee that finAPI will actually download transactions for the entire given date range, as the bank servers may limit the date range on their own. Also note that this parameter only applies to transactions, not to security positions; finAPI will always download all positions that it can get. At last, please note that this parameter is ignored when importing the 'demo connection'. This flag is currently not guaranteed to work for non-German banks!
 
 Returns:
 
 maxDaysForDownload
 - setMaxDaysForDownload
```
public void setMaxDaysForDownload(Integer maxDaysForDownload)
```
 - accountTypeIds
```
public ImportBankConnectionParams accountTypeIds(List<Long> accountTypeIds)
```
 - addAccountTypeIdsItem
```
public ImportBankConnectionParams addAccountTypeIdsItem(Long accountTypeIdsItem)
```
 - getAccountTypeIds
```
public List<Long> getAccountTypeIds()
```
 Whitelist of identifiers of finAPI account types that are considered for the import. Only accounts whose type matches with one of the given types will be imported. Note that when the bank connection does not contain any accounts of the given types, the import will fail with error code NO_ACCOUNTS_FOR_TYPE_LIST. If no whitelist is given, then all accounts will be imported. 1 = Checking, 2 = Savings, 3 = CreditCard, 4 = Security, 5 = Loan, 6 = Pocket (DEPRECATED; will not be returned for any account unless this type has explicitly been set via PATCH), 7 = Membership, 8 = Bausparen This flag is currently not guaranteed to work for non-German banks!
 
 Returns:
 
 accountTypeIds
 - setAccountTypeIds
```
public void setAccountTypeIds(List<Long> accountTypeIds)
```
 - challengeResponse
```
public ImportBankConnectionParams challengeResponse(String challengeResponse)
```
 - getChallengeResponse
```
public String getChallengeResponse()
```
 Challenge response. This field should be set only when the previous attempt of importing the bank connection failed with HTTP code 510, i.e. the bank sent a challenge for the user for an additional authentication. In this case, this field must contain the response to the bank's challenge.
 
 Returns:
 
 challengeResponse
 - setChallengeResponse
```
public void setChallengeResponse(String challengeResponse)
```
 - 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 ImportBankConnectionParams

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImportBankConnectionParams

Method Detail

bankId

getBankId

setBankId

bankingUserId

getBankingUserId

setBankingUserId

bankingCustomerId

getBankingCustomerId

setBankingCustomerId

bankingPin

getBankingPin

setBankingPin

storePin

isStorePin

setStorePin

name

getName

setName

skipPositionsDownload

isSkipPositionsDownload

setSkipPositionsDownload

loadOwnerData

isLoadOwnerData

setLoadOwnerData

maxDaysForDownload

getMaxDaysForDownload

setMaxDaysForDownload

accountTypeIds

addAccountTypeIdsItem

getAccountTypeIds

setAccountTypeIds

challengeResponse

getChallengeResponse

setChallengeResponse

equals

hashCode

toString