me.figo

Class FigoSession

java.lang.Object

me.figo.FigoApi

me.figo.FigoSession

public class FigoSession
extends FigoApi

Main entry point to the data access-part of the figo connect java library. Here you can retrieve all the data the user granted your app access to.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FigoSession.FieldVisited
static class	FigoSession.PendingTransactions

Field Summary

Fields inherited from class me.figo.FigoApi

API_FIGO_LIVE, API_FIGO_STAGE

Constructor Summary

Constructors

Constructor and Description
FigoSession(String accessToken) Creates a FigoSession instance
FigoSession(String accessToken, int timeout) Creates a FigoSession instance
FigoSession(String accessToken, int timeout, String apiEndpoint) Creates a FigoSession instance

Method Summary

Modifier and Type	Method and Description
Payment	addContainerPayment(PaymentContainer container)
Notification	addNotification(Notification notification) Register a new notification on the server for the user
Payment	addPayment(Payment payment) Create a new payment
void	cancelTask(String taskToken) Cancels a given task if possible
void	cancelTask(TaskTokenResponse tokenResponse) Cancels a given task if possible
TaskTokenResponse	createSyncTask(String state, String redirect_url, List<String> syncTasks, List<String> accountIds) Create a sync task
TaskTokenResponse	createSyncTask(String state, String redirect_url, List<String> syncTasks, List<String> accountIds, boolean disableNotifications, int ifNotSyncedSince, boolean autoContinue, boolean savePin) Create a sync task.
TaskTokenResponse	createSyncTask(SyncTokenRequest syncTokenRequest) Create a sync task
TaskTokenResponse	deleteStandingOrder(StandingOrder standingOrder) Create a deletion task for a standing order
TaskTokenResponse	deleteStandingOrder(String standingOrderId) Create a deletion task for a standing order
Account	getAccount(String accountId) Returns the account with the specified ID
AccountBalance	getAccountBalance(Account account) Returns the balance details of the supplied account
AccountBalance	getAccountBalance(String accountId) Returns the balance details of the account with he specified ID
List<Account>	getAccounts() All accounts the user has granted your app access to
Bank	getBank(Account account) Get Bank for account
Bank	getBank(String bankId) Get bank
BankLoginSettings	getLoginSettings(String countryCode, String bankCode) Returns the login settings for a specified banking or payment service
ServiceLoginSettings	getLoginSettingsForService(String countryCode, String serviceName)
Notification	getNotification(String notificationId) Retrieve a specific notification by ID
List<Notification>	getNotifications() All notifications registered by this client for the user
Payment	getPayment(Account account, String paymentId) Retrieve a specific payment by ID
Payment	getPayment(String accountId, String paymentId) Retrieve a specific payment by ID
List<PaymentProposal>	getPaymentProposals() Returns a list of PaymentProposals.
List<Payment>	getPayments() Retrieve all payments
List<Payment>	getPayments(Account account) all payments on a certain account
List<Payment>	getPayments(String accountId) Retrieve all payments on a certain account
List<Security>	getSecurities() Retrieves all securities of the current user
List<Security>	getSecurities(Account account) Retrieves all securities of a specific account
List<Security>	getSecurities(String accountId) Retrieves all securities of a specific account
Security	getSecurity(Account account, String securityId) Retrieves a specific security
Security	getSecurity(String accountId, String securityId) Retrieves a specific security
StandingOrder	getStandingOrder(String standingOrderId) Retrieve a specific standing order by ID
List<StandingOrder>	getStandingOrders() All standing orders on all accounts of the user
List<StandingOrder>	getStandingOrders(String accountId) Get an array of standing orders objects, one for each standing order of the user matching the criteria.
List<Service>	getSupportedServices() Returns a list of all supported credit cards and payment services for all countries
List<Service>	getSupportedServices(String countryCode) Returns a list of all supported credit cards and payment services for a country
String	getSyncURL(String state, String redirect_url) URL to trigger a synchronization.
String	getSyncURL(String state, String redirect_url, List<String> syncTasks) URL to trigger a synchronization.
String	getSyncURL(String state, String redirect_url, List<String> syncTasks, List<String> accountIds) URL to trigger a synchronization.
TaskStatusResponse	getTaskState(String tokenId) Get the current status of a Task by id
TaskStatusResponse	getTaskState(String tokenId, String pin) Deprecated.
TaskStatusResponse	getTaskState(TaskTokenResponse tokenResponse) Get the current status of a Task
Transaction	getTransaction(String accountId, String transactionId) Retrieve a specific transaction by ID
List<Transaction>	getTransactions() All transactions on all account of the user
List<Transaction>	getTransactions(Account account) Retrieve all transactions on a specific account of the user
List<Transaction>	getTransactions(Account account, String since, Integer count, Integer offset, FigoSession.PendingTransactions include_pending) Get an array of Transaction objects, one for each transaction of the user matching the criteria.
List<Transaction>	getTransactions(String accountId) Retrieve all transactions on a specific account of the user
List<Transaction>	getTransactions(String accountId, String since, Integer count, Integer offset, FigoSession.PendingTransactions include_pending) Get an array of Transaction objects, one for each transaction of the user matching the criteria.
User	getUser() Get the current figo Account
void	modifySecurities(Account account, FigoSession.FieldVisited visited) Modifies the visited field of all securities of a specific account
void	modifySecurities(FigoSession.FieldVisited visited) Modifies the visited field of all securities of the current user
void	modifySecurities(String accountId, FigoSession.FieldVisited visited) Modifies the visited field of all securities of a specific account
void	modifySecurity(Security security, FigoSession.FieldVisited visited) Modifies the visited field of a specific security
Payment	modifyStandingOrder(StandingOrder updatedStandingOrder) Update a standing order, this creates a new payment which has to be submitted to update the existing standing order
void	modifyTransaction(Transaction transaction, FigoSession.FieldVisited visited) Modifies the visited field of a specific transaction
void	modifyTransactions(Account account, FigoSession.FieldVisited visited) Modifies the visited field of all transactions of a specific account
void	modifyTransactions(FigoSession.FieldVisited visited) Modifies the visited field of all transactions of the current user
void	modifyTransactions(String accountId, FigoSession.FieldVisited visited) Modifies the visited field of all transactions of a specific account
protected <T> T	processResponse(HttpURLConnection connection, Type typeOfT) Method to process the response.
void	removeAccount(Account account) Remove an account
void	removeAccount(String accountId) Remove an account
void	removeBankPin(Bank bank) Remove the stored PIN for a bank (if there was one)
void	removeBankPin(String bankId) Remove the stored PIN for a bank (if there was one)
void	removeNotification(Notification notification) Remove a stored notification from the server
void	removePayment(Payment payment) Remove a stored payment from the server
void	removeTransaction(Transaction transaction) Removes a Transaction
void	removeUser() Delete figo Account
TaskStatusResponse	setupAndSyncAccount(FigoPinException exception, String newPin) Exception handler for a wrong pin.
TaskStatusResponse	setupAndSyncAccount(String bankCode, String countryCode, String loginName, String pin) Deprecated.
TaskStatusResponse	setupAndSyncAccount(String bankCode, String countryCode, String loginName, String pin, List<String> syncTasks) Setups an account an starts the initial syncronization directly
TaskTokenResponse	setupNewAccount(String bankCode, String countryCode, List<String> credentials) Deprecated.
TaskTokenResponse	setupNewAccount(String bankCode, String countryCode, List<String> credentials, List<String> syncTasks) Returns a TaskToken for a new account creation task
TaskTokenResponse	setupNewAccount(String bankCode, String countryCode, List<String> credentials, List<String> syncTasks, boolean savePin, boolean disable_first_sync)
TaskTokenResponse	setupNewAccount(String bankCode, String countryCode, String encryptedCredentials, List<String> syncTasks, boolean savePin, boolean disable_first_sync)
TaskTokenResponse	setupNewAccount(String bankCode, String countryCode, String loginName, String pin) Deprecated.
TaskTokenResponse	setupNewAccount(String bankCode, String countryCode, String loginName, String pin, List<String> syncTasks) Returns a TaskToken for a new account creation task
TaskTokenResponse	setupNewAccount(String bankCode, String countryCode, String loginName, String pin, List<String> syncTasks, boolean savePin, boolean disable_first_sync)
void	startTask(String taskToken) Start communication with bank server.
void	startTask(TaskTokenResponse tokenResponse) Start communication with bank server.
String	submitPayment(Payment payment, String tanSchemeId, String state) Submit payment to bank server
String	submitPayment(Payment payment, String tanSchemeId, String state, String redirectUri) Submit payment to bank server
TaskStatusResponse	submitResponseToTask(String tokenId, String response, TaskResponseType type)
TaskStatusResponse	submitResponseToTask(TaskTokenResponse tokenResponse, String response, TaskResponseType type)
Account	updateAccount(Account account) Modify an account
AccountBalance	updateAccountBalance(Account account, AccountBalance accountBalance) Modify balance or account limits
AccountBalance	updateAccountBalance(String accountId, AccountBalance accountBalance) Modify balance or account limits
Bank	updateBank(Bank bank) Modify a bank
Notification	updateNotification(Notification notification) Update a stored notification
Payment	updatePayment(Payment payment) Update a stored payment
User	updateUser(User user) Modify figo Account

Methods inherited from class me.figo.FigoApi

createGson, getApiEndpoint, getTimeout, handleResponse, queryApi, setProxy, setTimeout, setTrustManager, setupTrustManager

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FigoSession

public FigoSession(String accessToken)

Creates a FigoSession instance

Parameters:

accessToken - the access token to bind this session to a user

FigoSession

public FigoSession(String accessToken,
                   int timeout)

Creates a FigoSession instance

Parameters:

accessToken - the access token to bind this session to a user

timeout - the timeout used for queries

FigoSession

public FigoSession(String accessToken,
                   int timeout,
                   String apiEndpoint)

Creates a FigoSession instance

Parameters:

accessToken - the access token to bind this session to a user

timeout - the timeout used for queries

apiEndpoint - which endpoint to use (customize for different figo deployment)

Method Detail

getUser

public User getUser()
             throws FigoException,
                    IOException

Get the current figo Account

Returns:

User for the current figo Account

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

updateUser

public User updateUser(User user)
                throws FigoException,
                       IOException

Modify figo Account

Parameters:

user - modified user object to be saved

Returns:

User object for the updated figo Account

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

removeUser

public void removeUser()
                throws FigoException,
                       IOException

Delete figo Account

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getSupportedServices

public List<Service> getSupportedServices(String countryCode)
                                   throws FigoException,
                                          IOException

Returns a list of all supported credit cards and payment services for a country

Parameters:

countryCode -

Returns:

List of Services

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getSupportedServices

public List<Service> getSupportedServices()
                                   throws FigoException,
                                          IOException

Returns a list of all supported credit cards and payment services for all countries

Returns:

List of Services

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getLoginSettings

public BankLoginSettings getLoginSettings(String countryCode,
                                          String bankCode)
                                   throws FigoException,
                                          IOException

Returns the login settings for a specified banking or payment service

Parameters:

countryCode -

bankCode -

Returns:

LoginSettings

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getLoginSettingsForService

public ServiceLoginSettings getLoginSettingsForService(String countryCode,
                                                       String serviceName)
                                                throws IOException,
                                                       FigoException

Throws:

IOException

FigoException

setupNewAccount

@Deprecated
public TaskTokenResponse setupNewAccount(String bankCode,
                                                     String countryCode,
                                                     String loginName,
                                                     String pin)
                                              throws FigoException,
                                                     IOException

Deprecated.

Throws:

FigoException

IOException

setupNewAccount

public TaskTokenResponse setupNewAccount(String bankCode,
                                         String countryCode,
                                         String loginName,
                                         String pin,
                                         List<String> syncTasks)
                                  throws FigoException,
                                         IOException

Returns a TaskToken for a new account creation task

Parameters:

bankCode -

countryCode -

loginName -

pin -

syncTasks -

Returns:

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

setupNewAccount

public TaskTokenResponse setupNewAccount(String bankCode,
                                         String countryCode,
                                         String loginName,
                                         String pin,
                                         List<String> syncTasks,
                                         boolean savePin,
                                         boolean disable_first_sync)
                                  throws FigoException,
                                         IOException

Parameters:

bankCode -

countryCode -

syncTasks -

savePin -

disable_first_sync -

Returns:

Throws:

FigoException

IOException

setupNewAccount

@Deprecated
public TaskTokenResponse setupNewAccount(String bankCode,
                                                     String countryCode,
                                                     List<String> credentials)
                                              throws FigoException,
                                                     IOException

Deprecated.

Throws:

FigoException

IOException

setupNewAccount

public TaskTokenResponse setupNewAccount(String bankCode,
                                         String countryCode,
                                         List<String> credentials,
                                         List<String> syncTasks)
                                  throws FigoException,
                                         IOException

Returns a TaskToken for a new account creation task

Parameters:

bankCode -

countryCode -

credentials -

Returns:

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

setupNewAccount

public TaskTokenResponse setupNewAccount(String bankCode,
                                         String countryCode,
                                         List<String> credentials,
                                         List<String> syncTasks,
                                         boolean savePin,
                                         boolean disable_first_sync)
                                  throws FigoException,
                                         IOException

Parameters:

bankCode -

countryCode -

credentials -

syncTasks -

savePin -

disable_first_sync -

Returns:

Throws:

FigoException

IOException

setupNewAccount

public TaskTokenResponse setupNewAccount(String bankCode,
                                         String countryCode,
                                         String encryptedCredentials,
                                         List<String> syncTasks,
                                         boolean savePin,
                                         boolean disable_first_sync)
                                  throws FigoException,
                                         IOException

Parameters:

bankCode -

countryCode -

encryptedCredentials -

syncTasks -

savePin -

disable_first_sync -

Returns:

Throws:

FigoException

IOException

setupAndSyncAccount

@Deprecated
public TaskStatusResponse setupAndSyncAccount(String bankCode,
                                                          String countryCode,
                                                          String loginName,
                                                          String pin)
                                                   throws FigoException,
                                                          IOException,
                                                          FigoPinException,
                                                          InterruptedException

Deprecated.

Throws:

FigoException

IOException

FigoPinException

InterruptedException

setupAndSyncAccount

public TaskStatusResponse setupAndSyncAccount(String bankCode,
                                              String countryCode,
                                              String loginName,
                                              String pin,
                                              List<String> syncTasks)
                                       throws FigoException,
                                              IOException,
                                              FigoPinException,
                                              InterruptedException

Setups an account an starts the initial syncronization directly

Parameters:

bankCode -

countryCode -

loginName -

pin -

Returns:

TaskStatusResponse

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException, FigoPinException, InterruptedException

FigoPinException

InterruptedException

setupAndSyncAccount

public TaskStatusResponse setupAndSyncAccount(FigoPinException exception,
                                              String newPin)
                                       throws FigoException,
                                              IOException,
                                              FigoPinException,
                                              InterruptedException

Exception handler for a wrong pin. Starts a new task for account creation with a new pin

Parameters:

exception - FigoPinException which provides info about the account which should be created

newPin - new PIN

Returns:

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException, FigoPinException, InterruptedException

FigoPinException

InterruptedException

getAccounts

public List<Account> getAccounts()
                          throws FigoException,
                                 IOException

All accounts the user has granted your app access to

Returns:

List of Accounts

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getAccount

public Account getAccount(String accountId)
                   throws FigoException,
                          IOException

Returns the account with the specified ID

Parameters:

accountId - figo ID of the account to be retrieved

Returns:

Account or Null

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

updateAccount

public Account updateAccount(Account account)
                      throws FigoException,
                             IOException

Modify an account

Parameters:

account - the modified account to be saved

Returns:

Account object for the updated account returned by server

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

removeAccount

public void removeAccount(String accountId)
                   throws FigoException,
                          IOException

Remove an account

Parameters:

accountId - ID of the account to be removed

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

removeAccount

public void removeAccount(Account account)
                   throws FigoException,
                          IOException

Remove an account

Parameters:

account - Account to be removed

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getAccountBalance

public AccountBalance getAccountBalance(String accountId)
                                 throws FigoException,
                                        IOException

Returns the balance details of the account with he specified ID

Parameters:

accountId - figo ID of the account to be retrieved

Returns:

AccountBalance or Null

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getAccountBalance

public AccountBalance getAccountBalance(Account account)
                                 throws FigoException,
                                        IOException

Returns the balance details of the supplied account

Parameters:

account - account whose balance should be retrieved

Returns:

AccountBalance or Null

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

updateAccountBalance

public AccountBalance updateAccountBalance(String accountId,
                                           AccountBalance accountBalance)
                                    throws FigoException,
                                           IOException

Modify balance or account limits

Parameters:

accountId - ID of the account to be modified

accountBalance - modified AccountBalance object to be saved

Returns:

AccountBalance object for the updated account as returned by the server

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

updateAccountBalance

public AccountBalance updateAccountBalance(Account account,
                                           AccountBalance accountBalance)
                                    throws FigoException,
                                           IOException

Modify balance or account limits

Parameters:

account - account to be modified

accountBalance - modified AccountBalance object to be saved

Returns:

AccountBalance object for the updated account as returned by the server

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getTransactions

public List<Transaction> getTransactions()
                                  throws FigoException,
                                         IOException

All transactions on all account of the user

Returns:

List of Transaction objects

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getTransactions

public List<Transaction> getTransactions(String accountId)
                                  throws FigoException,
                                         IOException

Retrieve all transactions on a specific account of the user

Parameters:

accountId - the ID of the account for which to retrieve the transactions

Returns:

List of Transactions

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getTransactions

public List<Transaction> getTransactions(Account account)
                                  throws FigoException,
                                         IOException

Retrieve all transactions on a specific account of the user

Parameters:

account - the account for which to retrieve the transactions

Returns:

List of Transactions

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getTransactions

public List<Transaction> getTransactions(Account account,
                                         String since,
                                         Integer count,
                                         Integer offset,
                                         FigoSession.PendingTransactions include_pending)
                                  throws FigoException,
                                         IOException

Get an array of Transaction objects, one for each transaction of the user matching the criteria. Provide null values to not use the option.

Parameters:

account - account for which to list the transactions

since - this parameter can either be a transaction ID or a date

count - limit the number of returned transactions

offset - which offset into the result set should be used to determine the first transaction to return (useful in combination with count)

include_pending - this flag indicates whether pending transactions should be included in the response; pending transactions are always included as a complete set, regardless of the `since` parameter

Returns:

an array of Transaction objects

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getTransactions

public List<Transaction> getTransactions(String accountId,
                                         String since,
                                         Integer count,
                                         Integer offset,
                                         FigoSession.PendingTransactions include_pending)
                                  throws FigoException,
                                         IOException

Get an array of Transaction objects, one for each transaction of the user matching the criteria. Provide null values to not use the option.

Parameters:

accountId - ID of the account for which to list the transactions

since - this parameter can either be a transaction ID or a date

count - limit the number of returned transactions

offset - which offset into the result set should be used to determine the first transaction to return (useful in combination with count)

include_pending - this flag indicates whether pending transactions should be included in the response; pending transactions are always included as a complete set, regardless of the `since` parameter

Returns:

an array of Transaction objects

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getTransaction

public Transaction getTransaction(String accountId,
                                  String transactionId)
                           throws FigoException,
                                  IOException

Retrieve a specific transaction by ID

Parameters:

accountId - ID of the account on which the transaction occurred

transactionId - the figo ID of the specific transaction

Returns:

Transaction or null

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

modifyTransaction

public void modifyTransaction(Transaction transaction,
                              FigoSession.FieldVisited visited)
                       throws FigoException,
                              IOException

Modifies the visited field of a specific transaction

Parameters:

transaction - transaction which will be modified

visited - new value for the visited field

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

modifyTransactions

public void modifyTransactions(FigoSession.FieldVisited visited)
                        throws FigoException,
                               IOException

Modifies the visited field of all transactions of the current user

Parameters:

visited - new value for the visited field

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

modifyTransactions

public void modifyTransactions(Account account,
                               FigoSession.FieldVisited visited)
                        throws FigoException,
                               IOException

Modifies the visited field of all transactions of a specific account

Parameters:

account - account which owns the transactions

visited - new value for the visited field

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

modifyTransactions

public void modifyTransactions(String accountId,
                               FigoSession.FieldVisited visited)
                        throws FigoException,
                               IOException

Modifies the visited field of all transactions of a specific account

Parameters:

accountId - Id of the account which owns the transactions

visited - new value for the visited field

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

removeTransaction

public void removeTransaction(Transaction transaction)
                       throws FigoException,
                              IOException

Removes a Transaction

Parameters:

transaction - transaction which will be removed

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getStandingOrders

public List<StandingOrder> getStandingOrders(String accountId)
                                      throws FigoException,
                                             IOException

Get an array of standing orders objects, one for each standing order of the user matching the criteria. Provide null values to not use the option.

Parameters:

accountId - ID of the account for which to list the standing orders

Returns:

an array of Standing Order objects

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getStandingOrders

public List<StandingOrder> getStandingOrders()
                                      throws FigoException,
                                             IOException

All standing orders on all accounts of the user

Returns:

List of Standing Order objects

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getStandingOrder

public StandingOrder getStandingOrder(String standingOrderId)
                               throws FigoException,
                                      IOException

Retrieve a specific standing order by ID

Parameters:

standingOrderId - the figo ID of the specific standingOrder

Returns:

Standing Order or null

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

modifyStandingOrder

public Payment modifyStandingOrder(StandingOrder updatedStandingOrder)
                            throws IOException,
                                   FigoException

Update a standing order, this creates a new payment which has to be submitted to update the existing standing order

Parameters:

updatedStandingOrder - standing order where values which should be updated are set

Returns:

a payment object which has to be submitted

Throws:

IOException

FigoException

deleteStandingOrder

public TaskTokenResponse deleteStandingOrder(StandingOrder standingOrder)
                                      throws IOException,
                                             FigoException

Create a deletion task for a standing order

Parameters:

standingOrder - the standing order to delete

Returns:

a TaskToken for further processing

Throws:

IOException

FigoException

deleteStandingOrder

public TaskTokenResponse deleteStandingOrder(String standingOrderId)
                                      throws IOException,
                                             FigoException

Create a deletion task for a standing order

Parameters:

standingOrderId - the standing order id to delete

Returns:

a TaskToken for further processing

Throws:

IOException

FigoException

getSecurity

public Security getSecurity(String accountId,
                            String securityId)
                     throws FigoException,
                            IOException

Retrieves a specific security

Parameters:

accountId - id of the security owning account

securityId - id of the security which will be retrieved

Returns:

Security or null

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getSecurity

public Security getSecurity(Account account,
                            String securityId)
                     throws FigoException,
                            IOException

Retrieves a specific security

Parameters:

account - owning account

securityId - id of the security which will be retrieved

Returns:

Security or null

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getSecurities

public List<Security> getSecurities()
                             throws FigoException,
                                    IOException

Retrieves all securities of the current user

Returns:

List of Securities or null

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getSecurities

public List<Security> getSecurities(Account account)
                             throws FigoException,
                                    IOException

Retrieves all securities of a specific account

Parameters:

account - Security owning account

Returns:

List of Securities or null

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getSecurities

public List<Security> getSecurities(String accountId)
                             throws FigoException,
                                    IOException

Retrieves all securities of a specific account

Parameters:

accountId - Security owning account id

Returns:

List of Securities or null

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

modifySecurity

public void modifySecurity(Security security,
                           FigoSession.FieldVisited visited)
                    throws FigoException,
                           IOException

Modifies the visited field of a specific security

Parameters:

security - security which will be modified

visited - new value for the visited field

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

modifySecurities

public void modifySecurities(FigoSession.FieldVisited visited)
                      throws FigoException,
                             IOException

Modifies the visited field of all securities of the current user

Parameters:

visited - new value for the visited field

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

modifySecurities

public void modifySecurities(Account account,
                             FigoSession.FieldVisited visited)
                      throws FigoException,
                             IOException

Modifies the visited field of all securities of a specific account

Parameters:

account - account which owns the securities

visited - new value for the visited field

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

modifySecurities

public void modifySecurities(String accountId,
                             FigoSession.FieldVisited visited)
                      throws FigoException,
                             IOException

Modifies the visited field of all securities of a specific account

Parameters:

accountId - Id of the account which owns the securities

visited - new value for the visited field

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getBank

public Bank getBank(String bankId)
             throws FigoException,
                    IOException

Get bank

Parameters:

bankId - ID of the bank to be retrieved

Returns:

Bank or null

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getBank

public Bank getBank(Account account)
             throws FigoException,
                    IOException

Get Bank for account

Parameters:

account - Account for which to return the Bank

Returns:

Bank or Null

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

updateBank

public Bank updateBank(Bank bank)
                throws FigoException,
                       IOException

Modify a bank

Parameters:

bank - modified bank object to be saved

Returns:

Bank object for the updated bank

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

removeBankPin

public void removeBankPin(String bankId)
                   throws FigoException,
                          IOException

Remove the stored PIN for a bank (if there was one)

Parameters:

bankId - ID of the bank whose pin should be removed

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

removeBankPin

public void removeBankPin(Bank bank)
                   throws FigoException,
                          IOException

Remove the stored PIN for a bank (if there was one)

Parameters:

bank - bank whose pin should be removed

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getNotifications

public List<Notification> getNotifications()
                                    throws FigoException,
                                           IOException

All notifications registered by this client for the user

Returns:

List of Notification objects

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getNotification

public Notification getNotification(String notificationId)
                             throws FigoException,
                                    IOException

Retrieve a specific notification by ID

Parameters:

notificationId - figo ID for the notification to be retrieved

Returns:

Notification or Null

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

addNotification

public Notification addNotification(Notification notification)
                             throws FigoException,
                                    IOException

Register a new notification on the server for the user

Parameters:

notification - Notification which should be registered

Returns:

the newly registered Notification

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

updateNotification

public Notification updateNotification(Notification notification)
                                throws FigoException,
                                       IOException

Update a stored notification

Parameters:

notification - Notification with updated values

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

removeNotification

public void removeNotification(Notification notification)
                        throws FigoException,
                               IOException

Remove a stored notification from the server

Parameters:

notification - Notification to be removed

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getPayments

public List<Payment> getPayments()
                          throws FigoException,
                                 IOException

Retrieve all payments

Returns:

List of Payments

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getPayments

public List<Payment> getPayments(String accountId)
                          throws FigoException,
                                 IOException

Retrieve all payments on a certain account

Parameters:

accountId - the ID of the account for which to retrieve the payments

Returns:

List of Payments

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getPayments

public List<Payment> getPayments(Account account)
                          throws FigoException,
                                 IOException

all payments on a certain account

Parameters:

account - the account for which to retrieve the payments

Returns:

List of Payments

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getPayment

public Payment getPayment(String accountId,
                          String paymentId)
                   throws FigoException,
                          IOException

Retrieve a specific payment by ID

Parameters:

accountId - ID of the account on which the payment can be found

paymentId - ID of the payment to be retrieved

Returns:

Payment or Null

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getPayment

public Payment getPayment(Account account,
                          String paymentId)
                   throws FigoException,
                          IOException

Retrieve a specific payment by ID

Parameters:

account - the account on which the payment can be found

paymentId - ID of the payment to be retrieved

Returns:

Payment or Null

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

addPayment

public Payment addPayment(Payment payment)
                   throws FigoException,
                          IOException

Create a new payment

Parameters:

payment - Payment which should be created

Returns:

the newly created payment

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

addContainerPayment

public Payment addContainerPayment(PaymentContainer container)
                            throws FigoException,
                                   IOException

Throws:

FigoException

IOException

getPaymentProposals

public List<PaymentProposal> getPaymentProposals()
                                          throws FigoException,
                                                 IOException

Returns a list of PaymentProposals.

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

updatePayment

public Payment updatePayment(Payment payment)
                      throws FigoException,
                             IOException

Update a stored payment

Parameters:

payment - Payment with updated values

Returns:

updated Payment as returned by the server

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

removePayment

public void removePayment(Payment payment)
                   throws FigoException,
                          IOException

Remove a stored payment from the server

Parameters:

payment - payment to be removed

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

submitPayment

public String submitPayment(Payment payment,
                            String tanSchemeId,
                            String state)
                     throws FigoException,
                            IOException

Submit payment to bank server

Parameters:

payment - payment to be submitted

tanSchemeId - TAN scheme ID of user-selected TAN scheme

state - Any kind of string that will be forwarded in the callback response message

Returns:

the URL to be opened by the user for the TAN process

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

submitPayment

public String submitPayment(Payment payment,
                            String tanSchemeId,
                            String state,
                            String redirectUri)
                     throws FigoException,
                            IOException

Submit payment to bank server

Parameters:

payment - payment to be submitted

tanSchemeId - TAN scheme ID of user-selected TAN scheme

state - Any kind of string that will be forwarded in the callback response message

redirectUri - At the end of the submission process a response will be sent to this callback URL

Returns:

the URL to be opened by the user for the TAN process

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getSyncURL

public String getSyncURL(String state,
                         String redirect_url)
                  throws FigoException,
                         IOException

URL to trigger a synchronization. The user should open this URL in a web browser to synchronize his/her accounts with the respective bank servers. When the process is finished, the user is redirected to the provided URL.

Parameters:

state - String passed on through the complete synchronization process and to the redirect target at the end. It should be used to validated the authenticity of the call to the redirect URL

redirect_url - URI the user is redirected to after the process completes

Returns:

the URL to be opened by the user

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getSyncURL

public String getSyncURL(String state,
                         String redirect_url,
                         List<String> syncTasks)
                  throws FigoException,
                         IOException

URL to trigger a synchronization. The user should open this URL in a web browser to synchronize his/her accounts with the respective bank servers. When the process is finished, the user is redirected to the provided URL.

Parameters:

state - String passed on through the complete synchronization process and to the redirect target at the end. It should be used to validated the authenticity of the call to the redirect URL

redirect_url - URI the user is redirected to after the process completes

syncTasks - Tasks to sync while talking to the bank. Transactions are activated by default

Returns:

the URL to be opened by the user

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getSyncURL

public String getSyncURL(String state,
                         String redirect_url,
                         List<String> syncTasks,
                         List<String> accountIds)
                  throws FigoException,
                         IOException

URL to trigger a synchronization. The user should open this URL in a web browser to synchronize his/her accounts with the respective bank servers. When the process is finished, the user is redirected to the provided URL.

Parameters:

state - String passed on through the complete synchronization process and to the redirect target at the end. It should be used to validated the authenticity of the call to the redirect URL

redirect_url - URI the user is redirected to after the process completes

syncTasks - Tasks to sync while talking to the bank. Transactions are activated by default

accountIds - Accounts to sync

Returns:

the URL to be opened by the user

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

createSyncTask

public TaskTokenResponse createSyncTask(String state,
                                        String redirect_url,
                                        List<String> syncTasks,
                                        List<String> accountIds)
                                 throws IOException,
                                        FigoException

Create a sync task

Parameters:

state - String passed on through the complete synchronization process and to the redirect target at the end. It should be used to validated the authenticity of the call to the redirect URL

redirect_url - URI the user is redirected to after the process completes

syncTasks - Tasks to sync while talking to the bank. Transactions are activated by default

accountIds - Accounts to sync

Returns:

TaskTokenResponse

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

createSyncTask

public TaskTokenResponse createSyncTask(String state,
                                        String redirect_url,
                                        List<String> syncTasks,
                                        List<String> accountIds,
                                        boolean disableNotifications,
                                        int ifNotSyncedSince,
                                        boolean autoContinue,
                                        boolean savePin)
                                 throws IOException,
                                        FigoException

Create a sync task. Set the parameters you don't need to NULL

Parameters:

state - String passed on through the complete synchronization process and to the redirect target at the end. It should be used to validated the authenticity of the call to the redirect URL

redirect_url - URI the user is redirected to after the process completes

syncTasks - Tasks to sync while talking to the bank. Transactions are activated by default

accountIds - Accounts to sync

disableNotifications - Disable notifications for this sync

autoContinue - Continue on error

savePin - Save the pin for further syncs

Returns:

TaskTokenResponse

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

createSyncTask

public TaskTokenResponse createSyncTask(SyncTokenRequest syncTokenRequest)
                                 throws IOException,
                                        FigoException

Create a sync task

Parameters:

syncTokenRequest - A SyncTokenRequest object

Returns:

TaskTokenResponse

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getTaskState

public TaskStatusResponse getTaskState(TaskTokenResponse tokenResponse)
                                throws FigoException,
                                       IOException

Get the current status of a Task

Parameters:

tokenResponse - A TaskTokenResponse Object for the task which will be checked

Returns:

A TaskStatusResponse Object with information about the task

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getTaskState

public TaskStatusResponse getTaskState(String tokenId)
                                throws FigoException,
                                       IOException

Get the current status of a Task by id

Parameters:

tokenId - ID of the TaskToken which will be checked

Returns:

A TaskStatusResponse Object with information about the task.

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

getTaskState

@Deprecated
public TaskStatusResponse getTaskState(String tokenId,
                                                   String pin)
                                            throws FigoException,
                                                   IOException

Deprecated.

Throws:

FigoException

IOException

submitResponseToTask

public TaskStatusResponse submitResponseToTask(String tokenId,
                                               String response,
                                               TaskResponseType type)
                                        throws FigoException,
                                               IOException

Throws:

FigoException

IOException

submitResponseToTask

public TaskStatusResponse submitResponseToTask(TaskTokenResponse tokenResponse,
                                               String response,
                                               TaskResponseType type)
                                        throws FigoException,
                                               IOException

Throws:

FigoException

IOException

startTask

public void startTask(TaskTokenResponse tokenResponse)
               throws FigoException,
                      IOException

Start communication with bank server.

Parameters:

tokenResponse - TokenResponse Object

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

startTask

public void startTask(String taskToken)
               throws FigoException,
                      IOException

Start communication with bank server.

Parameters:

taskToken - Token ID

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

cancelTask

public void cancelTask(TaskTokenResponse tokenResponse)
                throws FigoException,
                       IOException

Cancels a given task if possible

Parameters:

tokenResponse - Token Response Object

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

cancelTask

public void cancelTask(String taskToken)
                throws FigoException,
                       IOException

Cancels a given task if possible

Parameters:

taskToken - Token ID

Throws:

FigoException - Base class for all figoExceptions

IOException - IOException

processResponse

protected <T> T processResponse(HttpURLConnection connection,
                                Type typeOfT)
                         throws IOException,
                                FigoException

Description copied from class: FigoApi

Method to process the response.

Overrides:

processResponse in class FigoApi

Returns:

Throws:

IOException - IOException

FigoException - Base class for all figoExceptions