de.adorsys.ledgers.middleware.api.service

Interface MiddlewareAccountManagementService

public interface MiddlewareAccountManagementService

Method Summary

Modifier and Type	Method and Description
SCAConsentResponseTO	authorizeConsent(String consentId, String authorisationId, String authCode) Authorizes a consent request.
boolean	confirmFundsAvailability(FundsConfirmationRequestTO request) Confirm the availability of funds on user account to perform the operation with specified amount
void	createDepositAccount(AccountDetailsTO depositAccount) Creates a new DepositAccount.
void	createDepositAccount(AccountDetailsTO depositAccount, List<AccountAccessTO> accountAccesss) Creates a new DepositAccount.
void	createDepositAccount(String accountNumberPrefix, String accountNumberSuffix, AccountDetailsTO accDetails) Creates a new DepositAccount for the connected user.
void	depositCash(String accountId, AmountTO amount) Deposits given amount in cash into specified account.
List<AccountDetailsTO>	getAllAccountDetailsByUserLogin(String userLogin) Retrieves a List of AccountDetails by user login (psuId)
AccountDetailsTO	getDepositAccountByIban(String iban, LocalDateTime time, boolean withBalance) Retrieves AccountDetails with Balance on demand
AccountDetailsTO	getDepositAccountById(String Id, LocalDateTime time, boolean withBalance) Retrieves AccountDetails with Balance on demand
TransactionTO	getTransactionById(String accountId, String transactionId) Retrieves transaction by accountId and transactionId
List<TransactionTO>	getTransactionsByDates(String accountId, LocalDate dateFrom, LocalDate dateTo) Retrieves a List of transactions by accountId and dates (from/to) if dateTo is empty it is considered that requested date is today
void	grantAccessToDepositAccount(AccountAccessTO accountAccess) Provide account access to another user of the system.
BearerTokenTO	grantAisConsent(AisConsentTO aisConsent) Provide a third party provider with necessary permission to read accounts and transaction informations for the specified account.
String	iban(String id)
List<AccountDetailsTO>	listOfDepositAccounts() Retrieve the list of account viewable by the connected user.
SCAConsentResponseTO	loadSCAForAisConsent(String consentId, String authorisationId)
SCAConsentResponseTO	selectSCAMethodForAisConsent(String consentId, String authorisationId, String scaMethodId)
SCAConsentResponseTO	startSCA(String consentId, AisConsentTO aisConsent) Start an account consent process.

Method Detail

createDepositAccount

void createDepositAccount(AccountDetailsTO depositAccount)
                   throws UserNotFoundMiddlewareException

Creates a new DepositAccount. This deposit account is then linked with the specified user. Call requires a bank staff access permission.

Parameters:

depositAccount - : the deposit account to be crated.

Throws:

UserNotFoundMiddlewareException - : if the associated user does not exist.

createDepositAccount

void createDepositAccount(AccountDetailsTO depositAccount,
                          List<AccountAccessTO> accountAccesss)
                   throws UserNotFoundMiddlewareException

Creates a new DepositAccount. This deposit account is then linked with the specified user. Call requires a bank staff access permission.

Parameters:

depositAccount - : the deposit account to be crated.

accountAccesss - : define who has access to the account.

Throws:

UserNotFoundMiddlewareException - : if the associated user does not exist.

createDepositAccount

void createDepositAccount(String accountNumberPrefix,
                          String accountNumberSuffix,
                          AccountDetailsTO accDetails)
                   throws AccountWithPrefixGoneMiddlewareException,
                          AccountWithSuffixExistsMiddlewareException,
                          UserNotFoundMiddlewareException

Creates a new DepositAccount for the connected user.

Parameters:

accountNumberPrefix - : the account number prefix : the account number prefix

accountNumberSuffix - : th eaccount number suffix

accDetails - : account to create.

Throws:

AccountWithPrefixGoneMiddlewareException - : another user owns this prefic

AccountWithSuffixExistsMiddlewareException - : user has account with same prefix and this suffix

UserNotFoundMiddlewareException - : no user

grantAccessToDepositAccount

void grantAccessToDepositAccount(AccountAccessTO accountAccess)
                          throws AccountNotFoundMiddlewareException,
                                 InsufficientPermissionMiddlewareException

Provide account access to another user of the system. In order to execute this operation, the connected user has to be the owner of the corresponding account.

Parameters:

accountAccess - : define who it being given access to the account.

Throws:

AccountNotFoundMiddlewareException - : target account not found.

InsufficientPermissionMiddlewareException - : if the connected user is not linked ot the account.

listOfDepositAccounts

List<AccountDetailsTO> listOfDepositAccounts()

Retrieve the list of account viewable by the connected user.

Returns:

an empty list if user not linked with any deposit accounted.

getDepositAccountById

AccountDetailsTO getDepositAccountById(String Id,
                                       LocalDateTime time,
                                       boolean withBalance)
                                throws AccountNotFoundMiddlewareException,
                                       InsufficientPermissionMiddlewareException

Retrieves AccountDetails with Balance on demand

Parameters:

Id - DepositAccount identifier

time - the reference time.

withBalance - boolean specifying if Balances has to be added to AccountDetails

Returns:

account details.

Throws:

AccountNotFoundMiddlewareException - : target account not found.

InsufficientPermissionMiddlewareException - : if the connected user is not linked ot the account.

getDepositAccountByIban

AccountDetailsTO getDepositAccountByIban(String iban,
                                         LocalDateTime time,
                                         boolean withBalance)
                                  throws AccountNotFoundMiddlewareException,
                                         InsufficientPermissionMiddlewareException

Retrieves AccountDetails with Balance on demand

Parameters:

iban - DepositAccount iban

time - the reference time.

withBalance - boolean specifying if Balances has to be added to AccountDetails

Returns:

account details.

Throws:

AccountNotFoundMiddlewareException - : target account not found.

InsufficientPermissionMiddlewareException - : if the connected user is not linked ot the account.

getAllAccountDetailsByUserLogin

List<AccountDetailsTO> getAllAccountDetailsByUserLogin(String userLogin)
                                                throws UserNotFoundMiddlewareException,
                                                       AccountNotFoundMiddlewareException,
                                                       InsufficientPermissionMiddlewareException

Retrieves a List of AccountDetails by user login (psuId)

Parameters:

userLogin - the user login

Returns:

list of account details.

Throws:

UserNotFoundMiddlewareException - : if the associated user does not exist.

AccountNotFoundMiddlewareException - : target account not found.

InsufficientPermissionMiddlewareException - : if the connected user is not linked ot the account.

getTransactionById

TransactionTO getTransactionById(String accountId,
                                 String transactionId)
                          throws AccountNotFoundMiddlewareException,
                                 TransactionNotFoundMiddlewareException,
                                 InsufficientPermissionMiddlewareException

Retrieves transaction by accountId and transactionId

Parameters:

accountId - the account id

transactionId - the transaction id

Returns:

the corresponding transaction

Throws:

AccountNotFoundMiddlewareException - : target account not found.

TransactionNotFoundMiddlewareException - : no transation with this id.

InsufficientPermissionMiddlewareException - : if the connected user is not linked ot the account.

getTransactionsByDates

List<TransactionTO> getTransactionsByDates(String accountId,
                                           LocalDate dateFrom,
                                           LocalDate dateTo)
                                    throws AccountNotFoundMiddlewareException,
                                           InsufficientPermissionMiddlewareException

Retrieves a List of transactions by accountId and dates (from/to) if dateTo is empty it is considered that requested date is today

Parameters:

accountId - the account id

dateFrom - from this time

dateTo - to this time

Returns:

: List of transactions.

Throws:

AccountNotFoundMiddlewareException - : target account not found.

InsufficientPermissionMiddlewareException - : if the connected user is not linked of the account.

confirmFundsAvailability

boolean confirmFundsAvailability(FundsConfirmationRequestTO request)
                          throws AccountNotFoundMiddlewareException

Confirm the availability of funds on user account to perform the operation with specified amount

Parameters:

request - : teh fund confirmation request.

Returns:

: true if fund available else false.

Throws:

AccountNotFoundMiddlewareException - : target account not found.

iban

String iban(String id)

startSCA

SCAConsentResponseTO startSCA(String consentId,
                              AisConsentTO aisConsent)
                       throws InsufficientPermissionMiddlewareException

Start an account consent process.

Parameters:

consentId - : the cosent id.

aisConsent - : the consent details

Returns:

the corresponding access token describing the account access

Throws:

InsufficientPermissionMiddlewareException - : if the connected user is not linked ot the account.

loadSCAForAisConsent

SCAConsentResponseTO loadSCAForAisConsent(String consentId,
                                          String authorisationId)
                                   throws SCAOperationExpiredMiddlewareException,
                                          AisConsentNotFoundMiddlewareException

Throws:

SCAOperationExpiredMiddlewareException

AisConsentNotFoundMiddlewareException

selectSCAMethodForAisConsent

SCAConsentResponseTO selectSCAMethodForAisConsent(String consentId,
                                                  String authorisationId,
                                                  String scaMethodId)
                                           throws PaymentNotFoundMiddlewareException,
                                                  SCAMethodNotSupportedMiddleException,
                                                  UserScaDataNotFoundMiddlewareException,
                                                  SCAOperationValidationMiddlewareException,
                                                  SCAOperationNotFoundMiddlewareException,
                                                  AisConsentNotFoundMiddlewareException

Throws:

PaymentNotFoundMiddlewareException

SCAMethodNotSupportedMiddleException

UserScaDataNotFoundMiddlewareException

SCAOperationValidationMiddlewareException

SCAOperationNotFoundMiddlewareException

AisConsentNotFoundMiddlewareException

authorizeConsent

SCAConsentResponseTO authorizeConsent(String consentId,
                                      String authorisationId,
                                      String authCode)
                               throws SCAOperationNotFoundMiddlewareException,
                                      SCAOperationValidationMiddlewareException,
                                      SCAOperationExpiredMiddlewareException,
                                      SCAOperationUsedOrStolenMiddlewareException,
                                      AisConsentNotFoundMiddlewareException

Authorizes a consent request. If the authentication is completed, the returned response will contain a valid bearer token.

Parameters:

consentId - : the cosent id

authorisationId - : the authorization id.

authCode - : SCAConsentResponseTO

Returns:

SCAConsentResponseTO : the consent response.

Throws:

SCAOperationNotFoundMiddlewareException - : operation no logger in db

SCAOperationValidationMiddlewareException - : operation data not valid.

SCAOperationExpiredMiddlewareException - : expired

SCAOperationUsedOrStolenMiddlewareException - : user sca method not supported.

AisConsentNotFoundMiddlewareException - : consent not found.

grantAisConsent

BearerTokenTO grantAisConsent(AisConsentTO aisConsent)
                       throws AccountNotFoundMiddlewareException,
                              InsufficientPermissionMiddlewareException

Provide a third party provider with necessary permission to read accounts and transaction informations for the specified account.

Parameters:

aisConsent - : the consent details

Returns:

the corresponding access token describing the account access

Throws:

AccountNotFoundMiddlewareException - : target account not found.

InsufficientPermissionMiddlewareException - : if the connected user is not linked ot the account.

depositCash

void depositCash(String accountId,
                 AmountTO amount)
          throws AccountNotFoundMiddlewareException

Deposits given amount in cash into specified account. On the bank's books, the bank debits its cash account for the given amount in cash, and credits a "deposits" liability account for an equal amount.

Parameters:

accountId - id of the account deposited into

amount - amount of cash deposited

Throws:

AccountNotFoundMiddlewareException - target account not found