me.figo.FigoSession Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation
Show all versions of sdk Show documentation
This SDK eases the development of Java applications and web services consuming the figo connect API.
Figo connect allows developers simple access to users bank data on a trustworthy basis. Users can grant your
application access to certain parts of their bank accounts and you can access them without worrying about the
inner workings of online banking.
//
// Copyright (c) 2013 figo GmbH
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
package me.figo;
import java.io.IOException;
import java.lang.reflect.Type;
import java.net.HttpURLConnection;
import java.net.URLEncoder;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import me.figo.models.*;
import me.figo.internal.ModifyStandingOrderRequest;
import me.figo.internal.SetupAccountRequest;
import me.figo.internal.SubmitPaymentRequest;
import me.figo.internal.SyncTokenRequest;
import me.figo.internal.TaskResponseType;
import me.figo.internal.TaskStatusRequest;
import me.figo.internal.TaskStatusResponse;
import me.figo.internal.TaskTokenResponse;
import me.figo.internal.VisitedRequest;
import me.figo.models.Account;
import me.figo.models.AccountBalance;
import me.figo.models.Bank;
import me.figo.models.CatalogBank.CatalogBanksResponse;
import me.figo.models.LoginSettings;
import me.figo.models.Notification;
import me.figo.models.Payment;
import me.figo.models.PaymentContainer;
import me.figo.models.PaymentProposal;
import me.figo.models.PaymentProposal.PaymentProposalResponse;
/**
* 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.
*
*
*/
public class FigoSession extends FigoApi {
public enum PendingTransactions {
INCLUDED,
EXCLUDED
}
public enum FieldVisited {
VISITED,
NOT_VISITED
}
/**
* Creates a FigoSession instance
*
* @param accessToken
* the access token to bind this session to a user
*/
public FigoSession(String accessToken) {
this(accessToken, 10000);
}
/**
* Creates a FigoSession instance
*
* @param accessToken
* the access token to bind this session to a user
* @param timeout
* the timeout used for queries
*/
public FigoSession(String accessToken, int timeout) {
super("Bearer " + accessToken, timeout);
}
/**
* Creates a FigoSession instance
*
* @param accessToken
* the access token to bind this session to a user
* @param timeout
* the timeout used for queries
* @param apiEndpoint
* which endpoint to use (customize for different figo deployment)
*/
public FigoSession(String accessToken, int timeout, String apiEndpoint) {
super(apiEndpoint, "Bearer " + accessToken, timeout);
}
/**
* Get the current figo Account
*
* @return User for the current figo Account
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public User getUser() throws FigoException, IOException {
return this.queryApi("/rest/user", null, "GET", User.class);
}
/**
* Modify figo Account
*
* @param user
* modified user object to be saved
* @return User object for the updated figo Account
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public User updateUser(User user) throws FigoException, IOException {
return this.queryApi("/rest/user", user, "PUT", User.class);
}
/**
* Delete figo Account
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void removeUser() throws FigoException, IOException {
this.queryApi("/rest/user", null, "DELETE", null);
}
/**
* Returns a list of all supported credit cards and payment services for a country
* @param countryCode
* @return List of Services
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getSupportedServices(String countryCode) throws FigoException, IOException {
Service.ServiceResponse response = this.queryApi("/rest/catalog/services/" + countryCode, null, "GET", Service.ServiceResponse.class);
return response == null ? null : response.getServices();
}
/**
* Returns a list of all supported credit cards and payment services for all countries
* @return List of Services
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getSupportedServices() throws FigoException, IOException {
Service.ServiceResponse response = this.queryApi("/rest/catalog/services", null, "GET",
Service.ServiceResponse.class);
return response == null ? null : response.getServices();
}
/**
* Returns the login settings for a specified banking or payment service
* @param countryCode
* @param bankCode
* @return LoginSettings
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public BankLoginSettings getLoginSettings(String countryCode, String bankCode) throws FigoException, IOException {
return this.queryApi("/rest/catalog/banks/" + countryCode + "/" + bankCode, null, "GET", BankLoginSettings.class);
}
public ServiceLoginSettings getLoginSettingsForService(String countryCode, String serviceName) throws IOException, FigoException {
return this.queryApi("/rest/catalog/services/" + countryCode + "/" + serviceName, null, "GET", ServiceLoginSettings.class);
}
/**
* Returns banks catalog by country
* @param countryCode ISO 3166-1
* @return CatalogBanksResponse containing a list of banks for that country
* @throws FigoException
* @throws IOException
*/
public CatalogBanksResponse getCatalogBanks(String countryCode) throws FigoException, IOException {
return this.queryApi("/rest/catalog/banks/" + countryCode, null, "GET", CatalogBanksResponse.class);
}
@Deprecated
/**
* Returns a TaskToken for a new account creation task
* @param bankCode
* @param countryCode
* @param loginName
* @param pin
* @return
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public TaskTokenResponse setupNewAccount(String bankCode, String countryCode, String loginName, String pin) throws FigoException, IOException {
return this.queryApi("/rest/accounts", new SetupAccountRequest(bankCode, countryCode, loginName, pin), "POST", TaskTokenResponse.class);
}
/**
* Returns a TaskToken for a new account creation task
* @param bankCode
* @param countryCode
* @param loginName
* @param pin
* @param syncTasks
* @return
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public TaskTokenResponse setupNewAccount(String bankCode, String countryCode, String loginName, String pin, List syncTasks) throws FigoException, IOException {
return this.queryApi("/rest/accounts", new SetupAccountRequest(bankCode, countryCode, loginName, pin, syncTasks), "POST", TaskTokenResponse.class);
}
/**
*
* @param bankCode
* @param countryCode
* @param syncTasks
* @param savePin
* @param disable_first_sync
* @return
* @throws FigoException
* @throws IOException
*/
public TaskTokenResponse setupNewAccount(String bankCode, String countryCode, String loginName, String pin, List syncTasks, boolean savePin, boolean disable_first_sync) throws FigoException, IOException {
List credentials = Arrays.asList(loginName, pin);
return this.queryApi("/rest/accounts", new SetupAccountRequest(bankCode, countryCode, credentials, syncTasks, savePin, disable_first_sync), "POST", TaskTokenResponse.class);
}
@Deprecated
/**
* Returns a TaskToken for a new account creation task
* @param bankCode
* @param countryCode
* @param loginName
* @param pin
* @return
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public TaskTokenResponse setupNewAccount(String bankCode, String countryCode, List credentials) throws FigoException, IOException {
return this.queryApi("/rest/accounts", new SetupAccountRequest(bankCode, countryCode, credentials, null), "POST", TaskTokenResponse.class);
}
/**
* Returns a TaskToken for a new account creation task
* @param bankCode
* @param countryCode
* @param credentials
* @return
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public TaskTokenResponse setupNewAccount(String bankCode, String countryCode, List credentials, List syncTasks) throws FigoException, IOException {
return this.queryApi("/rest/accounts", new SetupAccountRequest(bankCode, countryCode, credentials, syncTasks), "POST", TaskTokenResponse.class);
}
/**
*
* @param bankCode
* @param countryCode
* @param credentials
* @param syncTasks
* @param savePin
* @param disable_first_sync
* @return
* @throws FigoException
* @throws IOException
*/
public TaskTokenResponse setupNewAccount(String bankCode, String countryCode, List credentials, List syncTasks, boolean savePin, boolean disable_first_sync) throws FigoException, IOException {
return this.queryApi("/rest/accounts", new SetupAccountRequest(bankCode, countryCode, credentials, syncTasks, savePin, disable_first_sync), "POST", TaskTokenResponse.class);
}
/**
*
* @param bankCode
* @param countryCode
* @param encryptedCredentials
* @param syncTasks
* @param savePin
* @param disable_first_sync
* @return
* @throws FigoException
* @throws IOException
*/
public TaskTokenResponse setupNewAccount(String bankCode, String countryCode, String encryptedCredentials, List syncTasks, boolean savePin, boolean disable_first_sync) throws FigoException, IOException {
return this.queryApi("/rest/accounts", new SetupAccountRequest(bankCode, countryCode, encryptedCredentials, syncTasks, savePin, disable_first_sync), "POST", TaskTokenResponse.class);
}
@Deprecated
/**
* Setups an account an starts the initial syncronization directly
* @param bankCode
* @param countryCode
* @param loginName
* @param pin
* @return TaskStatusResponse
*
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException, InterruptedException
*/
public TaskStatusResponse setupAndSyncAccount(String bankCode, String countryCode, String loginName, String pin) throws FigoException, IOException, FigoPinException, InterruptedException {
return this.setupAndSyncAccount(bankCode, countryCode, loginName, pin, null);
}
/**
* Setups an account an starts the initial syncronization directly
* @param bankCode
* @param countryCode
* @param loginName
* @param pin
* @return TaskStatusResponse
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException, FigoPinException, InterruptedException
*/
public TaskStatusResponse setupAndSyncAccount(String bankCode, String countryCode, String loginName, String pin, ListsyncTasks) throws FigoException, IOException, FigoPinException, InterruptedException {
TaskTokenResponse tokenResponse = this.setupNewAccount(bankCode, countryCode, loginName, pin, syncTasks);
TaskStatusResponse taskStatus = this.getTaskState(tokenResponse);
while(!taskStatus.isEnded() && !taskStatus.isErroneous() && !taskStatus.isWaitingForPin() && !taskStatus.isWaitingForResponse()) {
taskStatus = this.getTaskState(tokenResponse);
Thread.sleep(1000);
}
if(taskStatus.isWaitingForPin() && !taskStatus.isEnded()) {
throw new FigoPinException(bankCode, countryCode, loginName, pin, tokenResponse);
}
else if(taskStatus.isErroneous() && taskStatus.isEnded()){
throw new FigoException("", taskStatus.getMessage());
}
return taskStatus;
}
/**
* Exception handler for a wrong pin. Starts a new task for account creation with a new pin
* @param exception
* FigoPinException which provides info about the account which should be created
* @param newPin
* new PIN
* @return
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException, FigoPinException, InterruptedException
*/
public TaskStatusResponse setupAndSyncAccount(FigoPinException exception, String newPin) throws FigoException, IOException, FigoPinException, InterruptedException {
return this.setupAndSyncAccount(exception.getBankCode(), exception.getCountryCode(), exception.getLoginName(), newPin);
}
/**
* All accounts the user has granted your app access to
*
* @return List of Accounts
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getAccounts() throws FigoException, IOException {
Account.AccountsResponse response = this.queryApi("/rest/accounts", null, "GET", Account.AccountsResponse.class);
return response == null ? null : response.getAccounts();
}
/**
* Returns the account with the specified ID
*
* @param accountId
* figo ID of the account to be retrieved
* @return Account or Null
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public Account getAccount(String accountId) throws FigoException, IOException {
return this.queryApi("/rest/accounts/" + accountId, null, "GET", Account.class);
}
/**
* Modify an account
*
* @param account
* the modified account to be saved
* @return Account object for the updated account returned by server
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public Account updateAccount(Account account) throws FigoException, IOException {
return this.queryApi("/rest/accounts/" + account.getAccountId(), account, "PUT", Account.class);
}
/**
* Remove an account
*
* @param accountId
* ID of the account to be removed
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void removeAccount(String accountId) throws FigoException, IOException {
this.queryApi("/rest/accounts/" + accountId, null, "DELETE", null);
}
/**
* Remove an account
*
* @param account
* Account to be removed
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void removeAccount(Account account) throws FigoException, IOException {
removeAccount(account.getAccountId());
}
/**
* Returns the balance details of the account with he specified ID
*
* @param accountId
* figo ID of the account to be retrieved
* @return AccountBalance or Null
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public AccountBalance getAccountBalance(String accountId) throws FigoException, IOException {
return this.queryApi("/rest/accounts/" + accountId + "/balance", null, "GET", AccountBalance.class);
}
/**
* Returns the balance details of the supplied account
*
* @param account
* account whose balance should be retrieved
* @return AccountBalance or Null
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public AccountBalance getAccountBalance(Account account) throws FigoException, IOException {
return getAccountBalance(account.getAccountId());
}
/**
* Modify balance or account limits
*
* @param accountId
* ID of the account to be modified
* @param accountBalance
* modified AccountBalance object to be saved
* @return AccountBalance object for the updated account as returned by the server
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public AccountBalance updateAccountBalance(String accountId, AccountBalance accountBalance) throws FigoException, IOException {
return this.queryApi("/rest/accounts/" + accountId + "/balance", accountBalance, "PUT", AccountBalance.class);
}
/**
* Modify balance or account limits
*
* @param account
* account to be modified
* @param accountBalance
* modified AccountBalance object to be saved
* @return AccountBalance object for the updated account as returned by the server
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public AccountBalance updateAccountBalance(Account account, AccountBalance accountBalance) throws FigoException, IOException {
return updateAccountBalance(account.getAccountId(), accountBalance);
}
/**
* All transactions on all account of the user
*
* @return List of Transaction objects
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getTransactions() throws FigoException, IOException {
return getTransactions((String) null);
}
/**
* Retrieve all transactions on a specific account of the user
*
* @param accountId
* the ID of the account for which to retrieve the transactions
* @return List of Transactions
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getTransactions(String accountId) throws FigoException, IOException {
return this.getTransactions(accountId, null, null, null, null);
}
/**
* Retrieve all transactions on a specific account of the user
*
* @param account
* the account for which to retrieve the transactions
* @return List of Transactions
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getTransactions(Account account) throws FigoException, IOException {
return this.getTransactions(account, null, null, null, null);
}
/**
* Get an array of Transaction objects, one for each transaction of the user matching the criteria. Provide null values to not use the option.
*
* @param account
* account for which to list the transactions
* @param since
* this parameter can either be a transaction ID or a date
* @param count
* limit the number of returned transactions
* @param offset
* which offset into the result set should be used to determine the first transaction to return (useful in combination with count)
* @param 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
* @return an array of Transaction objects
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getTransactions(Account account, String since, Integer count, Integer offset, PendingTransactions include_pending) throws FigoException, IOException {
return getTransactions(account == null ? null : account.getAccountId(), since, count, offset, include_pending);
}
/**
* Get an array of Transaction objects, one for each transaction of the user matching the criteria. Provide null values to not use the option.
*
* @param accountId
* ID of the account for which to list the transactions
* @param since
* this parameter can either be a transaction ID or a date
* @param count
* limit the number of returned transactions
* @param offset
* which offset into the result set should be used to determine the first transaction to return (useful in combination with count)
* @param 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
* @return an array of Transaction objects
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getTransactions(String accountId, String since, Integer count, Integer offset, PendingTransactions include_pending) throws FigoException, IOException {
String path = "";
if (accountId == null) {
path += "/rest/transactions?";
} else {
path += "/rest/accounts/" + accountId + "/transactions?";
}
if (since != null) {
path += "since=" + URLEncoder.encode(since, "ISO-8859-1") + "&";
}
if (count != null) {
path += "count=" + count + "&";
}
if (offset != null) {
path += "offset=" + offset + "&";
}
if (include_pending != null) {
path += "include_pending=" + (include_pending == PendingTransactions.INCLUDED ? "1" : "0");
}
Transaction.TransactionsResponse response = this.queryApi(path, null, "GET", Transaction.TransactionsResponse.class);
return response == null ? Collections.emptyList() : response.getTransactions();
}
/**
* Retrieve a specific transaction by ID
*
* @param accountId
* ID of the account on which the transaction occurred
* @param transactionId
* the figo ID of the specific transaction
* @return Transaction or null
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public Transaction getTransaction(String accountId, String transactionId) throws FigoException, IOException {
return this.queryApi("/rest/accounts/" + accountId + "/transactions/" + transactionId, null, "GET", Transaction.class);
}
/**
* Modifies the visited field of a specific transaction
* @param transaction
* transaction which will be modified
* @param visited
* new value for the visited field
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void modifyTransaction(Transaction transaction, FieldVisited visited) throws FigoException, IOException {
this.queryApi("/rest/accounts/" + transaction.getAccountId() + "/transactions/" + transaction.getTransactionId(), new VisitedRequest(visited == FieldVisited.VISITED), "PUT", null);
}
/**
* Modifies the visited field of all transactions of the current user
* @param visited
* new value for the visited field
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void modifyTransactions(FieldVisited visited) throws FigoException, IOException {
this.queryApi("/rest/transactions", new VisitedRequest(visited == FieldVisited.VISITED), "PUT", null);
}
/**
* Modifies the visited field of all transactions of a specific account
* @param account
* account which owns the transactions
* @param visited
* new value for the visited field
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void modifyTransactions(Account account, FieldVisited visited) throws FigoException, IOException {
this.queryApi("/rest/accounts/" + account.getAccountId() + "/transactions", new VisitedRequest(visited == FieldVisited.VISITED), "PUT", null);
}
/**
* Modifies the visited field of all transactions of a specific account
* @param accountId
* Id of the account which owns the transactions
* @param visited
* new value for the visited field
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void modifyTransactions(String accountId, FieldVisited visited) throws FigoException, IOException {
this.queryApi("/rest/accounts/" + accountId + "/transactions", new VisitedRequest(visited == FieldVisited.VISITED), "PUT", null);
}
/**
* Removes a Transaction
* @param transaction
* transaction which will be removed
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void removeTransaction(Transaction transaction) throws FigoException, IOException {
this.queryApi("/rest/accounts/" + transaction.getAccountId() + "/transactions/" + transaction.getTransactionId(), null, "DELETE", null);
}
/**
* 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.
*
* @param accountId
* ID of the account for which to list the standing orders
* @return an array of Standing Order objects
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getStandingOrders(String accountId) throws FigoException, IOException {
String path = "";
if (accountId == null) {
path += "/rest/standing_orders";
} else {
path += "/rest/accounts/" + accountId + "/standing_orders";
}
StandingOrder.StandingOrdersResponse response = this.queryApi(path, null, "GET", StandingOrder.StandingOrdersResponse.class);
return response == null ? Collections.emptyList() : response.getStandingOrders();
}
/**
* All standing orders on all accounts of the user
*
* @return List of Standing Order objects
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getStandingOrders() throws FigoException, IOException {
return getStandingOrders((String) null);
}
/**
* Retrieve a specific standing order by ID
*
* @param standingOrderId
* the figo ID of the specific standingOrder
* @return Standing Order or null
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public StandingOrder getStandingOrder(String standingOrderId) throws FigoException, IOException {
return this.queryApi("/rest/standing_orders/" + standingOrderId, null, "GET", StandingOrder.class);
}
/**
* Update a standing order, this creates a new payment which has to be submitted to update the existing
* standing order
* @param updatedStandingOrder standing order where values which should be updated are set
* @return a payment object which has to be submitted
* @throws IOException
* @throws FigoException
*/
public Payment modifyStandingOrder(StandingOrder updatedStandingOrder) throws IOException, FigoException {
String accountId = updatedStandingOrder.getAccountId();
ModifyStandingOrderRequest request = new ModifyStandingOrderRequest(updatedStandingOrder);
return this.queryApi("/rest/accounts/" + accountId + "/payments", request, "PUT", Payment.class);
}
/**
* Create a deletion task for a standing order
* @param standingOrder the standing order to delete
* @return a TaskToken for further processing
* @throws IOException
* @throws FigoException
*/
public TaskTokenResponse deleteStandingOrder(StandingOrder standingOrder) throws IOException, FigoException {
return this.queryApi("/rest/standing_orders/" + standingOrder.getStandingOrderId(), null, "DELETE", TaskTokenResponse.class);
}
/**
* Create a deletion task for a standing order
* @param standingOrderId the standing order id to delete
* @return a TaskToken for further processing
* @throws IOException
* @throws FigoException
*/
public TaskTokenResponse deleteStandingOrder(String standingOrderId) throws IOException, FigoException {
return this.queryApi("/rest/standing_orders/" + standingOrderId, null, "DELETE", TaskTokenResponse.class);
}
/**
* Retrieves a specific security
* @param accountId
* id of the security owning account
* @param securityId
* id of the security which will be retrieved
* @return Security or null
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public Security getSecurity(String accountId, String securityId) throws FigoException, IOException {
return this.queryApi("/rest/accounts/" + accountId + "/securities/" + securityId, null, "GET", Security.class);
}
/**
* Retrieves a specific security
* @param account
* owning account
* @param securityId
* id of the security which will be retrieved
* @return Security or null
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public Security getSecurity(Account account, String securityId) throws FigoException, IOException {
return this.queryApi("/rest/accounts/" + account.getAccountId() + "/securities/" + securityId, null, "GET", Security.class);
}
/**
* Retrieves all securities of the current user
* @return List of Securities or null
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getSecurities() throws FigoException, IOException {
Security.SecurityResponse response = this.queryApi("/rest/securities", null, "GET", Security.SecurityResponse.class);
return response == null ? Collections.emptyList() : response.getSecurities();
}
/**
* Retrieves all securities of a specific account
* @param account Security owning account
* @return List of Securities or null
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getSecurities(Account account) throws FigoException, IOException {
Security.SecurityResponse response = this.queryApi("/rest/accounts/" + account.getAccountId() + "/securities", null, "GET", Security.SecurityResponse.class);
return response == null ? Collections.emptyList() : response.getSecurities();
}
/**
* Retrieves all securities of a specific account
* @param accountId Security owning account id
* @return List of Securities or null
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getSecurities(String accountId) throws FigoException, IOException {
Security.SecurityResponse response = this.queryApi("/rest/accounts/" + accountId + "/securities", null, "GET", Security.SecurityResponse.class);
return response == null ? Collections.emptyList() : response.getSecurities();
}
/**
* Modifies the visited field of a specific security
* @param security
* security which will be modified
* @param visited
* new value for the visited field
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void modifySecurity(Security security, FieldVisited visited) throws FigoException, IOException {
this.queryApi("/rest/accounts/" + security.getAccountId() + "/securities/" + security.getSecurityId(), new VisitedRequest(visited == FieldVisited.VISITED), "PUT", null);
}
/**
* Modifies the visited field of all securities of the current user
* @param visited
* new value for the visited field
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void modifySecurities(FieldVisited visited) throws FigoException, IOException {
this.queryApi("/rest/securities", new VisitedRequest(visited == FieldVisited.VISITED), "PUT", null);
}
/**
* Modifies the visited field of all securities of a specific account
* @param account
* account which owns the securities
* @param visited
* new value for the visited field
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void modifySecurities(Account account, FieldVisited visited) throws FigoException, IOException {
this.queryApi("/rest/accounts/" + account.getAccountId() + "/securities", new VisitedRequest(visited == FieldVisited.VISITED), "PUT", null);
}
/**
* Modifies the visited field of all securities of a specific account
* @param accountId
* Id of the account which owns the securities
* @param visited
* new value for the visited field
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void modifySecurities(String accountId, FieldVisited visited) throws FigoException, IOException {
this.queryApi("/rest/accounts/" + accountId + "/securities", new VisitedRequest(visited == FieldVisited.VISITED), "PUT", null);
}
/**
* Get bank
*
* @param bankId
* ID of the bank to be retrieved
* @return Bank or null
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public Bank getBank(String bankId) throws FigoException, IOException {
return this.queryApi("/rest/banks/" + bankId, null, "GET", Bank.class);
}
/**
* Get Bank for account
*
* @param account
* Account for which to return the Bank
* @return Bank or Null
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public Bank getBank(Account account) throws FigoException, IOException {
return getBank(account.getBankId());
}
/**
* Modify a bank
*
* @param bank
* modified bank object to be saved
* @return Bank object for the updated bank
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public Bank updateBank(Bank bank) throws FigoException, IOException {
return this.queryApi("/rest/banks/" + bank.getBankId(), bank, "PUT", Bank.class);
}
/**
* Remove the stored PIN for a bank (if there was one)
*
* @param bankId
* ID of the bank whose pin should be removed
* @return
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public Bank removeBankPin(String bankId) throws FigoException, IOException {
Bank bankResponse = (Bank) this.queryApi("/rest/banks/" + bankId + "/remove_pin", null, "POST", null);
return bankResponse;
}
/**
* Remove the stored PIN for a bank (if there was one)
*
* @param bank
* bank whose pin should be removed
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public Bank removeBankPin(Bank bank) throws FigoException, IOException {
Bank bankResponse = (Bank) removeBankPin(bank.getBankId());
return bankResponse;
}
/**
* All notifications registered by this client for the user
*
* @return List of Notification objects
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getNotifications() throws FigoException, IOException {
Notification.NotificationsResponse response = this.queryApi("/rest/notifications", null, "GET", Notification.NotificationsResponse.class);
return response == null ? Collections.emptyList() : response.getNotifications();
}
/**
* Retrieve a specific notification by ID
*
* @param notificationId
* figo ID for the notification to be retrieved
* @return Notification or Null
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public Notification getNotification(String notificationId) throws FigoException, IOException {
return this.queryApi("/rest/notifications/" + notificationId, null, "GET", Notification.class);
}
/**
* Register a new notification on the server for the user
*
* @param notification
* Notification which should be registered
* @return the newly registered Notification
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public Notification addNotification(Notification notification) throws FigoException, IOException {
return this.queryApi("/rest/notifications", notification, "POST", Notification.class);
}
/**
* Update a stored notification
*
* @param notification
* Notification with updated values
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public Notification updateNotification(Notification notification) throws FigoException, IOException {
return this.queryApi("/rest/notifications/" + notification.getNotificationId(), notification, "PUT", Notification.class);
}
/**
* Remove a stored notification from the server
*
* @param notification
* Notification to be removed
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void removeNotification(Notification notification) throws FigoException, IOException {
this.queryApi("/rest/notifications/" + notification.getNotificationId(), null, "DELETE", null);
}
/**
* Retrieve all payments
*
* @return List of Payments
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getPayments() throws FigoException, IOException {
Payment.PaymentsResponse response = this.queryApi("/rest/payments", null, "GET", Payment.PaymentsResponse.class);
return response == null ? Collections.emptyList() : response.getPayments();
}
/**
* Retrieve all payments on a certain account
*
* @param accountId
* the ID of the account for which to retrieve the payments
* @return List of Payments
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getPayments(String accountId) throws FigoException, IOException {
Payment.PaymentsResponse response = this.queryApi("/rest/accounts/" + accountId + "/payments", null, "GET", Payment.PaymentsResponse.class);
return response == null ? Collections.emptyList() : response.getPayments();
}
/**
* all payments on a certain account
*
* @param account
* the account for which to retrieve the payments
* @return List of Payments
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getPayments(Account account) throws FigoException, IOException {
return this.getPayments(account.getAccountId());
}
/**
* Retrieve a specific payment by ID
*
* @param accountId
* ID of the account on which the payment can be found
* @param paymentId
* ID of the payment to be retrieved
* @return Payment or Null
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public Payment getPayment(String accountId, String paymentId) throws FigoException, IOException {
return this.queryApi("/rest/accounts/" + accountId + "/payments/" + paymentId, null, "GET", Payment.class);
}
/**
* Retrieve a specific payment by ID
*
* @param account
* the account on which the payment can be found
* @param paymentId
* ID of the payment to be retrieved
* @return Payment or Null
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public Payment getPayment(Account account, String paymentId) throws FigoException, IOException {
return this.getPayment(account.getAccountId(), paymentId);
}
/**
* Create a new payment
*
* @param payment
* Payment which should be created
* @return the newly created payment
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public Payment addPayment(Payment payment) throws FigoException, IOException {
return this.queryApi("/rest/accounts/" + payment.getAccountId() + "/payments", payment, "POST", Payment.class);
}
public Payment addContainerPayment(PaymentContainer container) throws FigoException, IOException {
return this.queryApi("/rest/accounts/" + container.getAccountId() + "/payments", container, "POST", PaymentContainer.class);
}
/**
* Returns a list of PaymentProposals.
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public List getPaymentProposals() throws FigoException, IOException {
PaymentProposalResponse response = this.queryApi("/rest/adress_book", null, "GET", PaymentProposalResponse.class);
return response == null ? Collections.emptyList() : response.getPaymentProposals();
}
/**
* Update a stored payment
*
* @param payment
* Payment with updated values
* @return updated Payment as returned by the server
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public Payment updatePayment(Payment payment) throws FigoException, IOException {
return this.queryApi("/rest/accounts/" + payment.getAccountId() + "/payments/" + payment.getPaymentId(), payment, "PUT", Payment.class);
}
/**
* Remove a stored payment from the server
*
* @param payment
* payment to be removed
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void removePayment(Payment payment) throws FigoException, IOException {
this.queryApi("/rest/accounts/" + payment.getAccountId() + "/payments/" + payment.getPaymentId(), null, "DELETE", null);
}
/**
* Submit payment to bank server
*
* @param payment
* payment to be submitted
* @param tanSchemeId
* TAN scheme ID of user-selected TAN scheme
* @param state
* Any kind of string that will be forwarded in the callback response message
* @return the URL to be opened by the user for the TAN process
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public String submitPayment(Payment payment, String tanSchemeId, String state) throws FigoException, IOException {
return submitPayment(payment, tanSchemeId, state, null);
}
/**
* Submit payment to bank server
*
* @param payment
* payment to be submitted
* @param tanSchemeId
* TAN scheme ID of user-selected TAN scheme
* @param state
* Any kind of string that will be forwarded in the callback response message
* @param redirectUri
* At the end of the submission process a response will be sent to this callback URL
* @return the URL to be opened by the user for the TAN process
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public String submitPayment(Payment payment, String tanSchemeId, String state, String redirectUri) throws FigoException, IOException {
TaskTokenResponse response = this.queryApi("/rest/accounts/" + payment.getAccountId() + "/payments/" + payment.getPaymentId() + "/submit",
new SubmitPaymentRequest(tanSchemeId, state, redirectUri), "POST", TaskTokenResponse.class);
return getApiEndpoint() + "/task/start?id=" + response.task_token;
}
/**
* 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.
*
* @param 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
* @param redirect_url
* URI the user is redirected to after the process completes
* @return the URL to be opened by the user
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public String getSyncURL(String state, String redirect_url) throws FigoException, IOException {
TaskTokenResponse response = this.queryApi("/rest/sync", new SyncTokenRequest(state, redirect_url), "POST", TaskTokenResponse.class);
return getApiEndpoint() + "/task/start?id=" + response.task_token;
}
/**
* 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.
*
* @param 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
* @param redirect_url
* URI the user is redirected to after the process completes
* @param syncTasks
* Tasks to sync while talking to the bank. Transactions are activated by default
* @return the URL to be opened by the user
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public String getSyncURL(String state, String redirect_url, ListsyncTasks) throws FigoException, IOException {
TaskTokenResponse response = this.queryApi("/rest/sync", new SyncTokenRequest(state, redirect_url, syncTasks), "POST", TaskTokenResponse.class);
return getApiEndpoint() + "/task/start?id=" + response.task_token;
}
/**
* 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.
*
* @param 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
* @param redirect_url
* URI the user is redirected to after the process completes
* @param syncTasks
* Tasks to sync while talking to the bank. Transactions are activated by default
* @param accountIds
* Accounts to sync
* @return the URL to be opened by the user
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public String getSyncURL(String state, String redirect_url, ListsyncTasks, ListaccountIds) throws FigoException, IOException {
TaskTokenResponse response = this.queryApi("/rest/sync", new SyncTokenRequest(state, redirect_url, syncTasks, accountIds), "POST", TaskTokenResponse.class);
return getApiEndpoint() + "/task/start?id=" + response.task_token;
}
/**
* Create a sync task
*
* @param 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
* @param redirect_url
* URI the user is redirected to after the process completes
* @param syncTasks
* Tasks to sync while talking to the bank. Transactions are activated by default
* @param accountIds
* Accounts to sync
* @return TaskTokenResponse
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public TaskTokenResponse createSyncTask(String state, String redirect_url, ListsyncTasks, ListaccountIds) throws IOException, FigoException {
return this.queryApi("/rest/sync", new SyncTokenRequest(state, redirect_url, syncTasks, accountIds), "POST", TaskTokenResponse.class);
}
/**
* Create a sync task.
*
* Set the parameters you don't need to NULL
*
* @param 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
* @param redirect_url
* URI the user is redirected to after the process completes
* @param syncTasks
* Tasks to sync while talking to the bank. Transactions are activated by default
* @param accountIds
* Accounts to sync
* @param disableNotifications
* Disable notifications for this sync
* @param autoContinue
* Continue on error
* @param savePin
* Save the pin for further syncs
* @return TaskTokenResponse
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public TaskTokenResponse createSyncTask(String state, String redirect_url, ListsyncTasks, ListaccountIds, boolean disableNotifications, int ifNotSyncedSince, boolean autoContinue, boolean savePin) throws IOException, FigoException {
return this.queryApi("/rest/sync", new SyncTokenRequest(state, redirect_url, syncTasks, accountIds, disableNotifications, ifNotSyncedSince, autoContinue, savePin), "POST", TaskTokenResponse.class);
}
/**
* Create a sync task
* @param syncTokenRequest
* A SyncTokenRequest object
*
* @return TaskTokenResponse
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public TaskTokenResponse createSyncTask(SyncTokenRequest syncTokenRequest) throws IOException, FigoException {
return this.queryApi("/rest/sync", syncTokenRequest, "POST", TaskTokenResponse.class);
}
/**
* Get the current status of a Task
* @param tokenResponse
* A TaskTokenResponse Object for the task which will be checked
* @return A TaskStatusResponse Object with information about the task
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public TaskStatusResponse getTaskState(TaskTokenResponse tokenResponse) throws FigoException, IOException {
return this.queryApi("/task/progress?id=" + tokenResponse.task_token, new TaskStatusRequest(tokenResponse), "POST", TaskStatusResponse.class);
}
/**
* Get the current status of a Task by id
* @param tokenId
* ID of the TaskToken which will be checked
* @return A TaskStatusResponse Object with information about the task.
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public TaskStatusResponse getTaskState(String tokenId) throws FigoException, IOException {
return this.queryApi("/task/progress?id=" + tokenId, new TaskStatusRequest(tokenId), "POST", TaskStatusResponse.class);
}
@Deprecated
/**
* Retrieves the current status of a Task and provide a PIN
* @param tokenId
* ID of the TaskToken which will be checked
* @param pin
* PIN which will be submitted
* @return A TaskStatusResponse Object with information about the task.
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public TaskStatusResponse getTaskState(String tokenId, String pin) throws FigoException, IOException {
return this.queryApi("/task/progress?id=" + tokenId, new TaskStatusRequest(tokenId, pin), "POST", TaskStatusResponse.class);
}
public TaskStatusResponse submitResponseToTask(String tokenId, String response, TaskResponseType type) throws FigoException, IOException {
/**
* This method is used to provide a response to a running Task.
* @param tokenId
* ID of the TaskToken which will receive the response
* @param response
* Your provided response as a String. For Boolean fields (SAVE_PIN and CONTINUE) the String values 0, 1 are used
* @param type
* Type of the response you want to submit. Available types are: PIN, SAVE_PIN, CHALLENGE and CONTINUE
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
TaskStatusRequest request = new TaskStatusRequest(tokenId);
switch (type) {
case PIN:
request.setPin(response);
request.setSavePin("0");
break;
case SAVE_PIN:
request.setPin(response);
request.setSavePin("1");
break;
case CHALLENGE:
request.setResponse(response);
break;
case CONTINUE:
request.setContinue(response);
break;
default:
break;
}
return this.queryApi("/task/progress?id=" + tokenId, request, "POST", TaskStatusResponse.class);
}
public TaskStatusResponse submitResponseToTask(TaskTokenResponse tokenResponse, String response, TaskResponseType type) throws FigoException, IOException {
/**
* This method is used to provide a response to a running Task.
* @param tokenResponse
* Response object of a task creating method
* @param response
* Your provided response as a String. For Boolean fields (SAVE_PIN and CONTINUE) the String values 0, 1 are used
* @param type
* Type of the response you want to submit. Available types are: PIN, SAVE_PIN, CHALLENGE and CONTINUE
*
*/
return this.submitResponseToTask(tokenResponse.getTaskToken(), response, type);
}
/**
* Start communication with bank server.
* @param tokenResponse
* TokenResponse Object
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void startTask(TaskTokenResponse tokenResponse) throws FigoException, IOException {
this.queryApi("/task/start?id=" + tokenResponse.task_token, null, "GET", null);
}
/**
* Start communication with bank server.
* @param taskToken
* Token ID
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void startTask(String taskToken) throws FigoException, IOException {
this.queryApi("/task/start?id=" + taskToken, null, "GET", null);
}
/**
* Cancels a given task if possible
* @param tokenResponse
* Token Response Object
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void cancelTask(TaskTokenResponse tokenResponse) throws FigoException, IOException {
this.queryApi("/task/cancel?id=" + tokenResponse.task_token, null, "POST", null);
}
/**
* Cancels a given task if possible
* @param taskToken
* Token ID
*
* @exception FigoException Base class for all figoExceptions
* @exception IOException IOException
*/
public void cancelTask(String taskToken) throws FigoException, IOException {
this.queryApi("/task/cancel?id=" + taskToken, null, "POST", null);
}
@Override
protected T processResponse(HttpURLConnection connection, Type typeOfT) throws IOException, FigoException {
// process response
return super.processResponse(connection, typeOfT);
}
}