de.adorsys.ledgers.middleware.api.service

Interface MiddlewareAccountManagementService

public interface MiddlewareAccountManagementService

Method Summary

Modifier and Type	Method and Description
SCAConsentResponseTO	authorizeConsent(ScaInfoTO scaInfoTO, String consentId) Authorizes a consent request.
boolean	changeStatus(String accountId, boolean systemBlock)
boolean	confirmFundsAvailability(FundsConfirmationRequestTO request) Confirm the availability of funds on user account to perform the operation with specified amount
void	createDepositAccount(ScaInfoTO scaInfoTO, String accountNumberPrefix, String accountNumberSuffix, AccountDetailsTO accDetails) Creates a new DepositAccount for the connected user.
void	createDepositAccount(String userId, ScaInfoTO scaInfoTO, AccountDetailsTO depositAccount) Creates a new DepositAccount.
void	deleteAccount(String userId, UserRoleTO userRole, String accountId)
void	deleteTransactions(String userId, UserRoleTO userRole, String accountId) Remove all transactions for deposit account
void	deleteUser(String userId, UserRoleTO userRole, String userToDeleteId)
void	depositCash(ScaInfoTO scaInfoTO, String accountId, AmountTO amount) Deposits given amount in cash into specified account.
List<AccountAccessTO>	getAccountAccesses(String userId) Retrieves a List of AccountAccessTO by userId
AccountReportTO	getAccountReport(String accountId)
CustomPageImpl<AccountDetailsExtendedTO>	getAccountsByBranchAndMultipleParams(String countryCode, String branchId, String branchLogin, String iban, Boolean blocked, CustomPageableImpl pageable)
List<AccountDetailsTO>	getAccountsByIbanAndCurrency(String iban, String currency)
List<AccountDetailsTO>	getAllAccountDetailsByUserLogin(String userLogin) Retrieves a List of AccountDetails by user login (psuId)
AccountDetailsTO	getDepositAccountByIban(String iban, LocalDateTime time, boolean withBalance) Deprecated. shall be removed in v2.5
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
CustomPageImpl<TransactionTO>	getTransactionsByDatesPaged(String accountId, LocalDate dateFrom, LocalDate dateTo, CustomPageableImpl pageable) Retrieves a List of transactions by accountId and dates (from/to) if dateTo is empty it is considered that requested date is today
SCAConsentResponseTO	grantAisConsent(ScaInfoTO scaInfoTO, AisConsentTO aisConsent) Provide a third party provider with necessary permission to read accounts and transaction information for the specified account.
String	iban(String id)
List<AccountDetailsTO>	listDepositAccounts(String userId) Retrieve the list of account viewable by the connected user.
List<AccountDetailsTO>	listDepositAccountsByBranch(String userId) TODO: return account or account details ??? Retrieve the list of account registered for the branch.
CustomPageImpl<AccountDetailsTO>	listDepositAccountsByBranchPaged(String userId, String queryParam, CustomPageableImpl pageable)
SCAConsentResponseTO	loadSCAForAisConsent(String userId, String consentId, String authorisationId)
SCAConsentResponseTO	selectSCAMethodForAisConsent(String userId, String consentId, String authorisationId, String scaMethodId)
SCAConsentResponseTO	startSCA(ScaInfoTO scaInfoTO, String consentId, AisConsentTO aisConsent) Start an account consent process.

Method Detail

getAccountsByIbanAndCurrency

List<AccountDetailsTO> getAccountsByIbanAndCurrency(String iban,
                                                    String currency)

createDepositAccount

void createDepositAccount(String userId,
                          ScaInfoTO scaInfoTO,
                          AccountDetailsTO depositAccount)

Creates a new DepositAccount. This deposit account is then linked with the specified user.

Call requires a bank staff access permission.

Parameters:

userId: - the identifier of the user for whom the account is created

scaInfoTO - : SCA information

depositAccount - : the deposit account to be crated.

createDepositAccount

void createDepositAccount(ScaInfoTO scaInfoTO,
                          String accountNumberPrefix,
                          String accountNumberSuffix,
                          AccountDetailsTO accDetails)

Creates a new DepositAccount for the connected user.

Parameters:

scaInfoTO - : SCA information

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

accountNumberSuffix - : th eaccount number suffix

accDetails - : account to create.

listDepositAccounts

List<AccountDetailsTO> listDepositAccounts(String userId)

Retrieve the list of account viewable by the connected user.

Parameters:

userId - : user identifier

Returns:

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

listDepositAccountsByBranch

List<AccountDetailsTO> listDepositAccountsByBranch(String userId)

TODO: return account or account details ??? Retrieve the list of account registered for the branch.

Parameters:

userId - : user identifier

Returns:

list of accounts registered for the branch, or an empty list otherwise

listDepositAccountsByBranchPaged

CustomPageImpl<AccountDetailsTO> listDepositAccountsByBranchPaged(String userId,
                                                                  String queryParam,
                                                                  CustomPageableImpl pageable)

getAccountsByBranchAndMultipleParams

CustomPageImpl<AccountDetailsExtendedTO> getAccountsByBranchAndMultipleParams(String countryCode,
                                                                              String branchId,
                                                                              String branchLogin,
                                                                              String iban,
                                                                              Boolean blocked,
                                                                              CustomPageableImpl pageable)

getDepositAccountById

AccountDetailsTO getDepositAccountById(String id,
                                       LocalDateTime time,
                                       boolean withBalance)

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.

getDepositAccountByIban

AccountDetailsTO getDepositAccountByIban(String iban,
                                         LocalDateTime time,
                                         boolean withBalance)

Deprecated. shall be removed in v2.5

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.

getAllAccountDetailsByUserLogin

List<AccountDetailsTO> getAllAccountDetailsByUserLogin(String userLogin)

Retrieves a List of AccountDetails by user login (psuId)

Parameters:

userLogin - the user login

Returns:

list of account details.

getTransactionById

TransactionTO getTransactionById(String accountId,
                                 String transactionId)

Retrieves transaction by accountId and transactionId

Parameters:

accountId - the account id

transactionId - the transaction id

Returns:

the corresponding transaction

getTransactionsByDates

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

Parameters:

accountId - the account id

dateFrom - from this time

dateTo - to this time

Returns:

: List of transactions.

getTransactionsByDatesPaged

CustomPageImpl<TransactionTO> getTransactionsByDatesPaged(String accountId,
                                                          LocalDate dateFrom,
                                                          LocalDate dateTo,
                                                          CustomPageableImpl pageable)

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.

confirmFundsAvailability

boolean confirmFundsAvailability(FundsConfirmationRequestTO request)

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.

iban

String iban(String id)

startSCA

SCAConsentResponseTO startSCA(ScaInfoTO scaInfoTO,
                              String consentId,
                              AisConsentTO aisConsent)

Start an account consent process.

Parameters:

scaInfoTO - SCA information

consentId - : the cosent id.

aisConsent - : the consent details

Returns:

the corresponding access token describing the account access

loadSCAForAisConsent

SCAConsentResponseTO loadSCAForAisConsent(String userId,
                                          String consentId,
                                          String authorisationId)

selectSCAMethodForAisConsent

SCAConsentResponseTO selectSCAMethodForAisConsent(String userId,
                                                  String consentId,
                                                  String authorisationId,
                                                  String scaMethodId)

authorizeConsent

SCAConsentResponseTO authorizeConsent(ScaInfoTO scaInfoTO,
                                      String consentId)

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

Parameters:

scaInfoTO - : SCA information

consentId - : the cosent id

Returns:

SCAConsentResponseTO : the consent response.

grantAisConsent

SCAConsentResponseTO grantAisConsent(ScaInfoTO scaInfoTO,
                                     AisConsentTO aisConsent)

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

Parameters:

scaInfoTO - : SCA information

aisConsent - : the consent details

Returns:

the corresponding access token describing the account access

depositCash

void depositCash(ScaInfoTO scaInfoTO,
                 String accountId,
                 AmountTO amount)

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:

scaInfoTO - SCA information

accountId - id of the account deposited into

amount - amount of cash deposited

getAccountAccesses

List<AccountAccessTO> getAccountAccesses(String userId)

Retrieves a List of AccountAccessTO by userId

Parameters:

userId - id of the user

deleteTransactions

void deleteTransactions(String userId,
                        UserRoleTO userRole,
                        String accountId)

Remove all transactions for deposit account

Parameters:

userId - id of the user

userRole - role of user initiating operation

accountId - the account id

deleteAccount

void deleteAccount(String userId,
                   UserRoleTO userRole,
                   String accountId)

deleteUser

void deleteUser(String userId,
                UserRoleTO userRole,
                String userToDeleteId)

getAccountReport

AccountReportTO getAccountReport(String accountId)

changeStatus

boolean changeStatus(String accountId,
                     boolean systemBlock)