UpdateBankConnectionParams (finapi-adapter 3.0.28 API)

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

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

Container for bank connection update parameters

Constructor Summary

Constructors
Constructor and Description

UpdateBankConnectionParams()

Constructors
Constructor and Description
`UpdateBankConnectionParams()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateBankConnectionParams`	`bankConnectionId(Long bankConnectionId)`
`UpdateBankConnectionParams`	`bankingPin(String bankingPin)`
`UpdateBankConnectionParams`	`challengeResponse(String challengeResponse)`
`boolean`	`equals(Object o)`
`Long`	`getBankConnectionId()` Bank connection identifier
`String`	`getBankingPin()` Online banking PIN.
`String`	`getChallengeResponse()` Challenge response.
`int`	`hashCode()`
`UpdateBankConnectionParams`	`importNewAccounts(Boolean importNewAccounts)`
`Boolean`	`isImportNewAccounts()` Whether new accounts that have not yet been imported will be imported or not.
`Boolean`	`isLoadOwnerData()` Whether to load/refresh information about the bank connection owner(s) - see field 'owners'.
`Boolean`	`isSkipPositionsDownload()` Whether to skip the download of transactions and securities or not.
`UpdateBankConnectionParams`	`loadOwnerData(Boolean loadOwnerData)`
`void`	`setBankConnectionId(Long bankConnectionId)`
`void`	`setBankingPin(String bankingPin)`
`void`	`setChallengeResponse(String challengeResponse)`
`void`	`setImportNewAccounts(Boolean importNewAccounts)`
`void`	`setLoadOwnerData(Boolean loadOwnerData)`
`void`	`setSkipPositionsDownload(Boolean skipPositionsDownload)`
`UpdateBankConnectionParams`	`skipPositionsDownload(Boolean skipPositionsDownload)`
`String`	`toString()`

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

- Constructor Detail
 - UpdateBankConnectionParams
```
public UpdateBankConnectionParams()
```
- Method Detail
 - bankConnectionId
```
public UpdateBankConnectionParams bankConnectionId(Long bankConnectionId)
```
 - getBankConnectionId
```
public Long getBankConnectionId()
```
 Bank connection identifier
 
 Returns:
 
 bankConnectionId
 - setBankConnectionId
```
public void setBankConnectionId(Long bankConnectionId)
```
 - bankingPin
```
public UpdateBankConnectionParams bankingPin(String bankingPin)
```
 - getBankingPin
```
public String getBankingPin()
```
 Online banking PIN. If a PIN is stored in the bank connection, then this field may remain unset. If the field is set though then it will always be used (even if there is some other PIN stored in the bank connection). Any symbols are allowed. Max length: 170.
 
 Returns:
 
 bankingPin
 - setBankingPin
```
public void setBankingPin(String bankingPin)
```
 - importNewAccounts
```
public UpdateBankConnectionParams importNewAccounts(Boolean importNewAccounts)
```
 - isImportNewAccounts
```
public Boolean isImportNewAccounts()
```
 Whether new accounts that have not yet been imported will be imported or not. Default is false. NOTES: • For best performance of the bank connection update, you should not enable this flag unless you really expect new accounts to be available in the connection. It is recommended to let your users tell you through your application when they want the service to look for new accounts. • If you have imported a bank connection using specific <code>accountTypeIds</code> (e.g. <code>1,2</code> to import checking and saving accounts), you would import all other accounts (e.g. security accounts or credit cards) by setting <code>importNewAccounts</code> to <code>true</code>. To avoid importing account types that you are not interested in, make sure this field is undefined or set to false.
 
 Returns:
 
 importNewAccounts
 - setImportNewAccounts
```
public void setImportNewAccounts(Boolean importNewAccounts)
```
 - skipPositionsDownload
```
public UpdateBankConnectionParams 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 <code>skipPositionsDownload=false</code> for a certain bank connection, you will no longer be able to make a request with <code>skipPositionsDownload=true</code> 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. This flag is currently not guaranteed to work for non-German banks!
 
 Returns:
 
 skipPositionsDownload
 - setSkipPositionsDownload
```
public void setSkipPositionsDownload(Boolean skipPositionsDownload)
```
 - loadOwnerData
```
public UpdateBankConnectionParams loadOwnerData(Boolean loadOwnerData)
```
 - isLoadOwnerData
```
public Boolean isLoadOwnerData()
```
 Whether to load/refresh information about the bank connection owner(s) - see field 'owners'. Default value is 'false'. Note that owner data is NOT loaded/refreshed during finAPI's automatic bank connection update.
 
 Returns:
 
 loadOwnerData
 - setLoadOwnerData
```
public void setLoadOwnerData(Boolean loadOwnerData)
```
 - challengeResponse
```
public UpdateBankConnectionParams challengeResponse(String challengeResponse)
```
 - getChallengeResponse
```
public String getChallengeResponse()
```
 Challenge response. This field should be set only when the previous attempt of update 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 UpdateBankConnectionParams

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UpdateBankConnectionParams

Method Detail

bankConnectionId

getBankConnectionId

setBankConnectionId

bankingPin

getBankingPin

setBankingPin

importNewAccounts

isImportNewAccounts

setImportNewAccounts

skipPositionsDownload

isSkipPositionsDownload

setSkipPositionsDownload

loadOwnerData

isLoadOwnerData

setLoadOwnerData

challengeResponse

getChallengeResponse

setChallengeResponse

equals

hashCode

toString