BankConnection (finapi-adapter 3.0.28 API)

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

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

Container for a bank connection's data

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BankConnection.CategorizationStatusEnum` Current status of transactions categorization.
`static class`	`BankConnection.TypeEnum` Bank connection type
`static class`	`BankConnection.UpdateStatusEnum` Current status of transactions download.

Constructor Summary

Constructors
Constructor and Description

BankConnection()

Constructors
Constructor and Description
`BankConnection()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BankConnection`	`accountIds(List<Long> accountIds)`
`BankConnection`	`addAccountIdsItem(Long accountIdsItem)`
`BankConnection`	`addOwnersItem(BankConnectionOwner ownersItem)`
`BankConnection`	`addTwoStepProceduresItem(TwoStepProcedure twoStepProceduresItem)`
`BankConnection`	`bank(Bank bank)`
`BankConnection`	`bankId(Long bankId)`
`BankConnection`	`bankingCustomerId(String bankingCustomerId)`
`BankConnection`	`bankingPin(String bankingPin)`
`BankConnection`	`bankingUserId(String bankingUserId)`
`BankConnection`	`categorizationStatus(BankConnection.CategorizationStatusEnum categorizationStatus)`
`BankConnection`	`collectiveMoneyTransferSupported(Boolean collectiveMoneyTransferSupported)`
`BankConnection`	`defaultTwoStepProcedureId(String defaultTwoStepProcedureId)`
`boolean`	`equals(Object o)`
`List<Long>`	`getAccountIds()` Identifiers of the accounts that belong to this bank connection
`Bank`	`getBank()` Bank that this connection belongs to
`Long`	`getBankId()` Identifier of the bank that this connection belongs to.
`String`	`getBankingCustomerId()` Stored online banking customer ID credential
`String`	`getBankingPin()` Stored online banking PIN.
`String`	`getBankingUserId()` Stored online banking user ID credential.
`BankConnection.CategorizationStatusEnum`	`getCategorizationStatus()` Current status of transactions categorization.
`String`	`getDefaultTwoStepProcedureId()` The default two-step-procedure.
`Long`	`getId()` Bank connection identifier
`UpdateResult`	`getLastAutoUpdate()` Result of the last auto update of this bank connection (ran by finAPI's automatic batch update process).
`UpdateResult`	`getLastManualUpdate()` Result of the last manual update of this bank connection.
`String`	`getName()` Custom name for the bank connection.
`List<BankConnectionOwner>`	`getOwners()` Information about the owner(s) of the bank connection
`List<TwoStepProcedure>`	`getTwoStepProcedures()` Available two-step-procedures for this bank connection, used for submitting a money transfer or direct debit request (see /accounts/requestSepaMoneyTransfer or /requestSepaDirectDebit).
`BankConnection.TypeEnum`	`getType()` Bank connection type
`BankConnection.UpdateStatusEnum`	`getUpdateStatus()` Current status of transactions download.
`int`	`hashCode()`
`BankConnection`	`ibanOnlyDirectDebitSupported(Boolean ibanOnlyDirectDebitSupported)`
`BankConnection`	`ibanOnlyMoneyTransferSupported(Boolean ibanOnlyMoneyTransferSupported)`
`BankConnection`	`id(Long id)`
`Boolean`	`isCollectiveMoneyTransferSupported()` <b>DEPRECATED! DO NOT USE THIS FIELD, AS IT IS UNRELIABLE.
`Boolean`	`isIbanOnlyDirectDebitSupported()` Whether this bank connection accepts direct debit requests where the debitor's account is defined just by the IBAN (without an additional BIC).
`Boolean`	`isIbanOnlyMoneyTransferSupported()` Whether this bank connection accepts money transfer requests where the recipient's account is defined just by the IBAN (without an additional BIC).
`BankConnection`	`lastAutoUpdate(UpdateResult lastAutoUpdate)`
`BankConnection`	`lastManualUpdate(UpdateResult lastManualUpdate)`
`BankConnection`	`name(String name)`
`BankConnection`	`owners(List<BankConnectionOwner> owners)`
`void`	`setAccountIds(List<Long> accountIds)`
`void`	`setBank(Bank bank)`
`void`	`setBankId(Long bankId)`
`void`	`setBankingCustomerId(String bankingCustomerId)`
`void`	`setBankingPin(String bankingPin)`
`void`	`setBankingUserId(String bankingUserId)`
`void`	`setCategorizationStatus(BankConnection.CategorizationStatusEnum categorizationStatus)`
`void`	`setCollectiveMoneyTransferSupported(Boolean collectiveMoneyTransferSupported)`
`void`	`setDefaultTwoStepProcedureId(String defaultTwoStepProcedureId)`
`void`	`setIbanOnlyDirectDebitSupported(Boolean ibanOnlyDirectDebitSupported)`
`void`	`setIbanOnlyMoneyTransferSupported(Boolean ibanOnlyMoneyTransferSupported)`
`void`	`setId(Long id)`
`void`	`setLastAutoUpdate(UpdateResult lastAutoUpdate)`
`void`	`setLastManualUpdate(UpdateResult lastManualUpdate)`
`void`	`setName(String name)`
`void`	`setOwners(List<BankConnectionOwner> owners)`
`void`	`setTwoStepProcedures(List<TwoStepProcedure> twoStepProcedures)`
`void`	`setType(BankConnection.TypeEnum type)`
`void`	`setUpdateStatus(BankConnection.UpdateStatusEnum updateStatus)`
`String`	`toString()`
`BankConnection`	`twoStepProcedures(List<TwoStepProcedure> twoStepProcedures)`
`BankConnection`	`type(BankConnection.TypeEnum type)`
`BankConnection`	`updateStatus(BankConnection.UpdateStatusEnum updateStatus)`

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

- Constructor Detail
  - BankConnection
```
public BankConnection()
```
- Method Detail
  - id
```
public BankConnection id(Long id)
```
  - getId
```
public Long getId()
```
    Bank connection identifier
    
    Returns:
    
    id
  - setId
```
public void setId(Long id)
```
  - bankId
```
public BankConnection bankId(Long bankId)
```
  - getBankId
```
public Long getBankId()
```
    Identifier of the bank that this connection belongs to. NOTE: This field is DEPRECATED and will get removed at some point. Please refer to the 'bank' field instead.
    
    Returns:
    
    bankId
  - setBankId
```
public void setBankId(Long bankId)
```
  - bank
```
public BankConnection bank(Bank bank)
```
  - getBank
```
public Bank getBank()
```
    Bank that this connection belongs to
    
    Returns:
    
    bank
  - setBank
```
public void setBank(Bank bank)
```
  - name
```
public BankConnection name(String name)
```
  - getName
```
public String getName()
```
    Custom name for the bank connection. You can set this field with the 'Edit a bank connection' service, as well as during the initial import of the bank connection. Maximum length is 64.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - bankingUserId
```
public BankConnection bankingUserId(String bankingUserId)
```
  - getBankingUserId
```
public String getBankingUserId()
```
    Stored online banking user ID credential. This field may be null for the 'demo connection'.
    
    Returns:
    
    bankingUserId
  - setBankingUserId
```
public void setBankingUserId(String bankingUserId)
```
  - bankingCustomerId
```
public BankConnection bankingCustomerId(String bankingCustomerId)
```
  - getBankingCustomerId
```
public String getBankingCustomerId()
```
    Stored online banking customer ID credential
    
    Returns:
    
    bankingCustomerId
  - setBankingCustomerId
```
public void setBankingCustomerId(String bankingCustomerId)
```
  - bankingPin
```
public BankConnection bankingPin(String bankingPin)
```
  - getBankingPin
```
public String getBankingPin()
```
    Stored online banking PIN. If a PIN is stored, this will always be 'XXXXX'.
    
    Returns:
    
    bankingPin
  - setBankingPin
```
public void setBankingPin(String bankingPin)
```
  - type
```
public BankConnection type(BankConnection.TypeEnum type)
```
  - getType
```
public BankConnection.TypeEnum getType()
```
    Bank connection type
    
    Returns:
    
    type
  - setType
```
public void setType(BankConnection.TypeEnum type)
```
  - updateStatus
```
public BankConnection updateStatus(BankConnection.UpdateStatusEnum updateStatus)
```
  - getUpdateStatus
```
public BankConnection.UpdateStatusEnum getUpdateStatus()
```
    Current status of transactions download. The POST /bankConnections/import and POST /bankConnections/<id>/update services will set this flag to IN_PROGRESS before they return. Once the import or update has finished, the status will be changed to READY.
    
    Returns:
    
    updateStatus
  - setUpdateStatus
```
public void setUpdateStatus(BankConnection.UpdateStatusEnum updateStatus)
```
  - categorizationStatus
```
public BankConnection categorizationStatus(BankConnection.CategorizationStatusEnum categorizationStatus)
```
  - getCategorizationStatus
```
public BankConnection.CategorizationStatusEnum getCategorizationStatus()
```
    Current status of transactions categorization. The asynchronous download process that is triggered by a call of the POST /bankConnections/import and POST /bankConnections/<id>/update services (and also by finAPI's auto update, if enabled) will set this flag to PENDING once the download has finished and a categorization is scheduled for the imported transactions. A separate categorization thread will then start to categorize the transactions (during this process, the status is IN_PROGRESS). When categorization has finished, the status will be (re-)set to READY. Note that the current categorization status should only be queried after the download has finished, i.e. once the download status has switched from IN_PROGRESS to READY.
    
    Returns:
    
    categorizationStatus
  - setCategorizationStatus
```
public void setCategorizationStatus(BankConnection.CategorizationStatusEnum categorizationStatus)
```
  - lastManualUpdate
```
public BankConnection lastManualUpdate(UpdateResult lastManualUpdate)
```
  - getLastManualUpdate
```
public UpdateResult getLastManualUpdate()
```
    Result of the last manual update of this bank connection. If no manual update has ever been done so far, then this field will not be set.
    
    Returns:
    
    lastManualUpdate
  - setLastManualUpdate
```
public void setLastManualUpdate(UpdateResult lastManualUpdate)
```
  - lastAutoUpdate
```
public BankConnection lastAutoUpdate(UpdateResult lastAutoUpdate)
```
  - getLastAutoUpdate
```
public UpdateResult getLastAutoUpdate()
```
    Result of the last auto update of this bank connection (ran by finAPI's automatic batch update process). If no auto update has ever been done so far, then this field will not be set.
    
    Returns:
    
    lastAutoUpdate
  - setLastAutoUpdate
```
public void setLastAutoUpdate(UpdateResult lastAutoUpdate)
```
  - twoStepProcedures
```
public BankConnection twoStepProcedures(List<TwoStepProcedure> twoStepProcedures)
```
  - addTwoStepProceduresItem
```
public BankConnection addTwoStepProceduresItem(TwoStepProcedure twoStepProceduresItem)
```
  - getTwoStepProcedures
```
public List<TwoStepProcedure> getTwoStepProcedures()
```
    Available two-step-procedures for this bank connection, used for submitting a money transfer or direct debit request (see /accounts/requestSepaMoneyTransfer or /requestSepaDirectDebit). The available two-step-procedures are re-evaluated each time this bank connection is updated (/bankConnections/update). This means that this list may change as a result of an update.
    
    Returns:
    
    twoStepProcedures
  - setTwoStepProcedures
```
public void setTwoStepProcedures(List<TwoStepProcedure> twoStepProcedures)
```
  - ibanOnlyMoneyTransferSupported
```
public BankConnection ibanOnlyMoneyTransferSupported(Boolean ibanOnlyMoneyTransferSupported)
```
  - isIbanOnlyMoneyTransferSupported
```
public Boolean isIbanOnlyMoneyTransferSupported()
```
    Whether this bank connection accepts money transfer requests where the recipient's account is defined just by the IBAN (without an additional BIC). This field is re-evaluated each time this bank connection is updated. See also: /accounts/requestSepaMoneyTransfer
    
    Returns:
    
    ibanOnlyMoneyTransferSupported
  - setIbanOnlyMoneyTransferSupported
```
public void setIbanOnlyMoneyTransferSupported(Boolean ibanOnlyMoneyTransferSupported)
```
  - ibanOnlyDirectDebitSupported
```
public BankConnection ibanOnlyDirectDebitSupported(Boolean ibanOnlyDirectDebitSupported)
```
  - isIbanOnlyDirectDebitSupported
```
public Boolean isIbanOnlyDirectDebitSupported()
```
    Whether this bank connection accepts direct debit requests where the debitor's account is defined just by the IBAN (without an additional BIC). This field is re-evaluated each time this bank connection is updated. See also: /accounts/requestSepaDirectDebit
    
    Returns:
    
    ibanOnlyDirectDebitSupported
  - setIbanOnlyDirectDebitSupported
```
public void setIbanOnlyDirectDebitSupported(Boolean ibanOnlyDirectDebitSupported)
```
  - collectiveMoneyTransferSupported
```
public BankConnection collectiveMoneyTransferSupported(Boolean collectiveMoneyTransferSupported)
```
  - isCollectiveMoneyTransferSupported
```
public Boolean isCollectiveMoneyTransferSupported()
```
    <b>DEPRECATED! DO NOT USE THIS FIELD, AS IT IS UNRELIABLE. INSTEAD, REFER TO THE 'supportedOrders' FIELD IN THE ACCOUNT RESOURCE.</b><br/><br/>Whether this bank connection supports submitting collective money transfers. This field is re-evaluated each time this bank connection is updated. See also: /accounts/requestSepaMoneyTransfer
    
    Returns:
    
    collectiveMoneyTransferSupported
  - setCollectiveMoneyTransferSupported
```
public void setCollectiveMoneyTransferSupported(Boolean collectiveMoneyTransferSupported)
```
  - defaultTwoStepProcedureId
```
public BankConnection defaultTwoStepProcedureId(String defaultTwoStepProcedureId)
```
  - getDefaultTwoStepProcedureId
```
public String getDefaultTwoStepProcedureId()
```
    The default two-step-procedure. Must match one of the available 'procedureId's from the 'twoStepProcedures' list. When this field is set, you can execute two-step-procedures (accounts/requestSepaMoneyTransfer or /requestSepaDirectDebit) without having to explicitly set a procedure. finAPI will use the default procedure in such cases. Note that the list of available procedures of a bank connection may change as a result of an update of the connection, and if this field references a procedure that is no longer available after an update, finAPI will automatically clear the default procedure (set it to null).
    
    Returns:
    
    defaultTwoStepProcedureId
  - setDefaultTwoStepProcedureId
```
public void setDefaultTwoStepProcedureId(String defaultTwoStepProcedureId)
```
  - accountIds
```
public BankConnection accountIds(List<Long> accountIds)
```
  - addAccountIdsItem
```
public BankConnection addAccountIdsItem(Long accountIdsItem)
```
  - getAccountIds
```
public List<Long> getAccountIds()
```
    Identifiers of the accounts that belong to this bank connection
    
    Returns:
    
    accountIds
  - setAccountIds
```
public void setAccountIds(List<Long> accountIds)
```
  - owners
```
public BankConnection owners(List<BankConnectionOwner> owners)
```
  - addOwnersItem
```
public BankConnection addOwnersItem(BankConnectionOwner ownersItem)
```
  - getOwners
```
public List<BankConnectionOwner> getOwners()
```
    Information about the owner(s) of the bank connection
    
    Returns:
    
    owners
  - setOwners
```
public void setOwners(List<BankConnectionOwner> owners)
```
  - 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 BankConnection

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BankConnection

Method Detail

id

getId

setId

bankId

getBankId

setBankId

bank

getBank

setBank

name

getName

setName

bankingUserId

getBankingUserId

setBankingUserId

bankingCustomerId

getBankingCustomerId

setBankingCustomerId

bankingPin

getBankingPin

setBankingPin

type

getType

setType

updateStatus

getUpdateStatus

setUpdateStatus

categorizationStatus

getCategorizationStatus

setCategorizationStatus

lastManualUpdate

getLastManualUpdate

setLastManualUpdate

lastAutoUpdate

getLastAutoUpdate

setLastAutoUpdate

twoStepProcedures

addTwoStepProceduresItem

getTwoStepProcedures

setTwoStepProcedures

ibanOnlyMoneyTransferSupported

isIbanOnlyMoneyTransferSupported

setIbanOnlyMoneyTransferSupported

ibanOnlyDirectDebitSupported

isIbanOnlyDirectDebitSupported

setIbanOnlyDirectDebitSupported

collectiveMoneyTransferSupported

isCollectiveMoneyTransferSupported

setCollectiveMoneyTransferSupported

defaultTwoStepProcedureId

getDefaultTwoStepProcedureId

setDefaultTwoStepProcedureId

accountIds

addAccountIdsItem

getAccountIds

setAccountIds

owners

addOwnersItem

getOwners

setOwners

equals

hashCode

toString