Package de.adorsys.ledgers.oba.rest.api.resource

Interface AISApi

public interface AISApi

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_PATH

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<ConsentAuthorizeResponse>	aisDone(String encryptedConsentId, String authorisationId, boolean isOauth2Integrated, String authConfirmationCode)	This call provides the server with the opportunity to close this session and redirect the PSU to the TPP or close the application window.
org.springframework.http.ResponseEntity<ConsentAuthorizeResponse>	authrizedConsent(String encryptedConsentId, String authorisationId, String authCode)	Provides a TAN for the validation of an authorization
org.springframework.http.ResponseEntity<ConsentAuthorizeResponse>	login(String encryptedConsentId, String authorisationId, String login, String pin)	Identifies the user by login an pin.
org.springframework.http.ResponseEntity<ConsentAuthorizeResponse>	revokeConsent(String encryptedConsentId, String authorisationId)	Fails AIS Consent authorisation object by its ID.
org.springframework.http.ResponseEntity<ConsentAuthorizeResponse>	selectMethod(String encryptedConsentId, String authorisationId, String scaMethodId)	Selects the SCA Method for use.
org.springframework.http.ResponseEntity<ConsentAuthorizeResponse>	startConsentAuth(String encryptedConsentId, String authorisationId, de.adorsys.ledgers.middleware.api.domain.um.AisConsentTO aisConsent)	Start the consent process.

Field Detail

BASE_PATH

static final String BASE_PATH

See Also:

Constant Field Values

Method Detail

login

@PostMapping(path="/{encryptedConsentId}/authorisation/{authorisationId}/login")
org.springframework.http.ResponseEntity<ConsentAuthorizeResponse> login(@PathVariable("encryptedConsentId")
                                                                        String encryptedConsentId,
                                                                        @PathVariable("authorisationId")
                                                                        String authorisationId,
                                                                        @RequestParam(value="login",required=false)
                                                                        String login,
                                                                        @RequestParam(value="pin",required=false)
                                                                        String pin)

Identifies the user by login an pin.

The returned object contains:

• A list of accounts

  This is supposed to be used to display the list of accounts to the psu

• An AisConsent object

  This consent is initialized, but might not contain any more information

Parameters:

encryptedConsentId - the encryptedConsentId

authorisationId - the auth id

login - the login

pin - the password

Returns:

ConsentAuthorizeResponse

startConsentAuth

@PostMapping("/{encryptedConsentId}/authorisation/{authorisationId}/start")
org.springframework.http.ResponseEntity<ConsentAuthorizeResponse> startConsentAuth(@PathVariable("encryptedConsentId")
                                                                                   String encryptedConsentId,
                                                                                   @PathVariable("authorisationId")
                                                                                   String authorisationId,
                                                                                   @RequestBody
                                                                                   de.adorsys.ledgers.middleware.api.domain.um.AisConsentTO aisConsent)

Start the consent process. By sending the customer request consent to the core banking.

Parameters:

encryptedConsentId - the encrypted consent id

authorisationId - the authorization id

aisConsent - the consent request object

Returns:

ConsentAuthorizeResponse

selectMethod

@PostMapping("/{encryptedConsentId}/authorisation/{authorisationId}/methods/{scaMethodId}")
org.springframework.http.ResponseEntity<ConsentAuthorizeResponse> selectMethod(@PathVariable("encryptedConsentId")
                                                                               String encryptedConsentId,
                                                                               @PathVariable("authorisationId")
                                                                               String authorisationId,
                                                                               @PathVariable("scaMethodId")
                                                                               String scaMethodId)

Selects the SCA Method for use.

Parameters:

encryptedConsentId - the sca id

authorisationId - the auth id

scaMethodId - sca

Returns:

ConsentAuthorizeResponse

authrizedConsent

@PostMapping(path="/{encryptedConsentId}/authorisation/{authorisationId}/authCode",
             params="authCode")
org.springframework.http.ResponseEntity<ConsentAuthorizeResponse> authrizedConsent(@PathVariable("encryptedConsentId")
                                                                                   String encryptedConsentId,
                                                                                   @PathVariable("authorisationId")
                                                                                   String authorisationId,
                                                                                   @RequestParam("authCode")
                                                                                   String authCode)

Provides a TAN for the validation of an authorization

Parameters:

encryptedConsentId - the sca id

authorisationId - the auth id

authCode - the auth code

Returns:

ConsentAuthorizeResponse

aisDone

@GetMapping(path="/{encryptedConsentId}/authorisation/{authorisationId}/done")
org.springframework.http.ResponseEntity<ConsentAuthorizeResponse> aisDone(@PathVariable("encryptedConsentId")
                                                                          String encryptedConsentId,
                                                                          @PathVariable("authorisationId")
                                                                          String authorisationId,
                                                                          @RequestParam(name="oauth2",required=false,defaultValue="false")
                                                                          boolean isOauth2Integrated,
                                                                          @RequestParam(name="authConfirmationCode",required=false)
                                                                          String authConfirmationCode)

This call provides the server with the opportunity to close this session and redirect the PSU to the TPP or close the application window.

In any case, the session of the user will be closed.

Parameters:

encryptedConsentId -

authorisationId -

Returns:

revokeConsent

@DeleteMapping(path="/{encryptedConsentId}/{authorisationId}")
org.springframework.http.ResponseEntity<ConsentAuthorizeResponse> revokeConsent(@PathVariable("encryptedConsentId")
                                                                                String encryptedConsentId,
                                                                                @PathVariable("authorisationId")
                                                                                String authorisationId)

Fails AIS Consent authorisation object by its ID.

Parameters:

encryptedConsentId - ID of Consent

Returns:

true if consent authorisation was found and failed. false otherwise.