de.adorsys.ledgers.middleware.api.service

Interface MiddlewareOnlineBankingService

public interface MiddlewareOnlineBankingService

Interface used for the initialization of user interaction. Implementation of this interface will generally not require user interaction.

Author:

fpo

Method Summary

Modifier and Type	Method and Description
SCALoginResponseTO	authenticateForLogin(ScaInfoTO scaInfoTO) PROC: 02c
SCALoginResponseTO	authorise(String login, String pin, UserRoleTO role) Performs user authorization.
SCALoginResponseTO	authoriseForConsent(String login, String pin, String consentId, String authorisationId, OpTypeTO opType) Special login associated with a account information, a payment or a payment cancellation consent.
SCALoginResponseTO	generateLoginAuthCode(ScaInfoTO scaInfoTO, String userMessage, int validitySeconds) After the PSU selects the SCA method, this is called to generate and send the login auth code.
UserTO	register(String login, String email, String pin, UserRoleTO role) Registers a User.
BearerTokenTO	validate(String accessToken) Caller can be sure that returned user object contains a mirror of permissions contained in the token.

Method Detail

register

UserTO register(String login,
                String email,
                String pin,
                UserRoleTO role)

Registers a User.

Parameters:

login - the login of the user

email - the email of the user

pin - the pin of this user

role - the initial role of the user.

Returns:

: user

authorise

SCALoginResponseTO authorise(String login,
                             String pin,
                             UserRoleTO role)

Performs user authorization.

The returned String will be a signed JWT containing user access rights and sca data.

Parameters:

login - User login

pin - User PIN

role - The intended role.

Returns:

a session id for success, false for failure or trows a

authoriseForConsent

SCALoginResponseTO authoriseForConsent(String login,
                                       String pin,
                                       String consentId,
                                       String authorisationId,
                                       OpTypeTO opType)

Special login associated with a account information, a payment or a payment cancellation consent.

Parameters:

login - the login of the customer

pin - the password of the customer

consentId - the consentId or paymentId

authorisationId - the authorisationId

opType - the operation type

Returns:

login response

validate

BearerTokenTO validate(String accessToken)

Caller can be sure that returned user object contains a mirror of permissions contained in the token. This is generally a subset of permissions really held by the user. If during validation we notice that the user has less permission for the listed account, the token will be discarded an no user object will be returned.

Parameters:

accessToken - : the access token

Returns:

the bearer token

generateLoginAuthCode

SCALoginResponseTO generateLoginAuthCode(ScaInfoTO scaInfoTO,
                                         String userMessage,
                                         int validitySeconds)

After the PSU selects the SCA method, this is called to generate and send the login auth code.

Parameters:

scaInfoTO - SCA information

userMessage - message to user

validitySeconds - validity in secondn.

Returns:

SCALoginResponseTO the response object.

authenticateForLogin

SCALoginResponseTO authenticateForLogin(ScaInfoTO scaInfoTO)

PROC: 02c

This is called when the user enters the received code.

Parameters:

scaInfoTO - : SCA information

Returns:

the login response.