de.adorsys.psd2.consent.api.service

Interface PisAuthorisationServiceBase

All Known Subinterfaces:

PisAuthorisationService, PisAuthorisationServiceEncrypted

public interface PisAuthorisationServiceBase

Base version of PisAuthorisationService that contains all method declarations. Should not be implemented directly, consider using one of the interfaces that extends this one.

See Also:

PisAuthorisationService, PisAuthorisationServiceEncrypted

Method Summary

Modifier and Type	Method and Description
Optional<CreatePisAuthorisationResponse>	createAuthorization(String paymentId, CreatePisAuthorisationRequest request) Creates payment authorization
Optional<CreatePisAuthorisationResponse>	createAuthorizationCancellation(String paymentId, CreatePisAuthorisationRequest pisAuthorisationRequest) Creates payment authorization cancellation
Optional<List<String>>	getAuthorisationsByPaymentId(String paymentId, de.adorsys.psd2.xs2a.core.pis.PaymentAuthorisationType authorisationType) Gets list of payment authorisation IDs by payment ID and authorisation type
Optional<de.adorsys.psd2.xs2a.core.sca.AuthorisationScaApproachResponse>	getAuthorisationScaApproach(String authorisationId, de.adorsys.psd2.xs2a.core.pis.PaymentAuthorisationType authorisationType) Gets SCA approach from the authorisation by authorisation ID and authorisation type
Optional<de.adorsys.psd2.xs2a.core.sca.ScaStatus>	getAuthorisationScaStatus(String paymentId, String authorisationId, de.adorsys.psd2.xs2a.core.pis.PaymentAuthorisationType authorisationType) Gets SCA status of the authorisation by payment ID, authorisation ID and authorisation type
Optional<GetPisAuthorisationResponse>	getPisAuthorisationById(String authorisationId) Get information about Authorisation by authorisation identifier
Optional<GetPisAuthorisationResponse>	getPisCancellationAuthorisationById(String cancellationId) Get information about Authorisation by cancellation identifier
boolean	isAuthenticationMethodDecoupled(String authorisationId, String authenticationMethodId) Checks if requested authentication method is decoupled.
boolean	saveAuthenticationMethods(String authorisationId, List<CmsScaMethod> methods) Saves authentication methods in provided authorisation
Optional<UpdatePisCommonPaymentPsuDataResponse>	updatePisAuthorisation(String authorisationId, UpdatePisCommonPaymentPsuDataRequest request) Updates payment authorization
boolean	updatePisAuthorisationStatus(String authorisationId, de.adorsys.psd2.xs2a.core.sca.ScaStatus scaStatus) Updates a specific payment authorisation's status
Optional<UpdatePisCommonPaymentPsuDataResponse>	updatePisCancellationAuthorisation(String authorizationId, UpdatePisCommonPaymentPsuDataRequest request) Updates payment cancellation authorization
boolean	updateScaApproach(String authorisationId, de.adorsys.psd2.xs2a.core.profile.ScaApproach scaApproach) Updates pis sca approach

Method Detail

createAuthorization

Optional<CreatePisAuthorisationResponse> createAuthorization(String paymentId,
                                                             CreatePisAuthorisationRequest request)

Creates payment authorization

Parameters:

paymentId - String representation of the payment identifier

request - PIS authorisation request

Returns:

Response containing authorization id

createAuthorizationCancellation

Optional<CreatePisAuthorisationResponse> createAuthorizationCancellation(String paymentId,
                                                                         CreatePisAuthorisationRequest pisAuthorisationRequest)

Creates payment authorization cancellation

Parameters:

paymentId - String representation of the payment identifier

pisAuthorisationRequest - PIS authorisation request

Returns:

Response containing authorization id

updatePisAuthorisation

Optional<UpdatePisCommonPaymentPsuDataResponse> updatePisAuthorisation(String authorisationId,
                                                                       UpdatePisCommonPaymentPsuDataRequest request)

Updates payment authorization

Parameters:

authorisationId - String representation of the authorisation identifier

request - Incoming request for updating authorization

Returns:

Response containing SCA status, available and chosen Sca method

updatePisAuthorisationStatus

boolean updatePisAuthorisationStatus(String authorisationId,
                                     de.adorsys.psd2.xs2a.core.sca.ScaStatus scaStatus)

Updates a specific payment authorisation's status

Parameters:

authorisationId - String representation of the authorisation identifier

scaStatus - The to be updated status

Returns:

updatePisCancellationAuthorisation

Optional<UpdatePisCommonPaymentPsuDataResponse> updatePisCancellationAuthorisation(String authorizationId,
                                                                                   UpdatePisCommonPaymentPsuDataRequest request)

Updates payment cancellation authorization

Parameters:

authorizationId - String representation of the authorisation identifier

request - Incoming request for updating authorization

Returns:

Response containing SCA status, available and chosen Sca method

getPisAuthorisationById

Optional<GetPisAuthorisationResponse> getPisAuthorisationById(String authorisationId)

Get information about Authorisation by authorisation identifier

Parameters:

authorisationId - String representation of the authorisation identifier

Returns:

Response containing information about Authorisation

getPisCancellationAuthorisationById

Optional<GetPisAuthorisationResponse> getPisCancellationAuthorisationById(String cancellationId)

Get information about Authorisation by cancellation identifier

Parameters:

cancellationId - String representation of the cancellation identifier

Returns:

Response containing information about Authorisation

getAuthorisationsByPaymentId

Optional<List<String>> getAuthorisationsByPaymentId(String paymentId,
                                                    de.adorsys.psd2.xs2a.core.pis.PaymentAuthorisationType authorisationType)

Gets list of payment authorisation IDs by payment ID and authorisation type

Parameters:

paymentId - String representation of the payment identifier

authorisationType - Type of authorisation

Returns:

Response containing information about authorisation IDs

getAuthorisationScaStatus

Optional<de.adorsys.psd2.xs2a.core.sca.ScaStatus> getAuthorisationScaStatus(String paymentId,
                                                                            String authorisationId,
                                                                            de.adorsys.psd2.xs2a.core.pis.PaymentAuthorisationType authorisationType)

Gets SCA status of the authorisation by payment ID, authorisation ID and authorisation type

Parameters:

paymentId - String representation of the payment identifier

authorisationId - String representation of the authorisation identifier

authorisationType - Type of authorisation

Returns:

SCA status of the authorisation

isAuthenticationMethodDecoupled

boolean isAuthenticationMethodDecoupled(String authorisationId,
                                        String authenticationMethodId)

Checks if requested authentication method is decoupled.

Parameters:

authorisationId - String representation of the authorisation identifier

authenticationMethodId - String representation of the available authentication method identifier

Returns:

true, if authentication method is decoupled and false otherwise.

saveAuthenticationMethods

boolean saveAuthenticationMethods(String authorisationId,
                                  List<CmsScaMethod> methods)

Saves authentication methods in provided authorisation

Parameters:

authorisationId - String representation of the authorisation identifier

methods - List of authentication methods to be saved

Returns:

true if authorisation was found and updated, false otherwise

updateScaApproach

boolean updateScaApproach(String authorisationId,
                          de.adorsys.psd2.xs2a.core.profile.ScaApproach scaApproach)

Updates pis sca approach

Parameters:

authorisationId - String representation of the authorisation identifier

scaApproach - chosen sca approach

Returns:

true if authorisation was found and sca approach updated, false otherwise

getAuthorisationScaApproach

Optional<de.adorsys.psd2.xs2a.core.sca.AuthorisationScaApproachResponse> getAuthorisationScaApproach(String authorisationId,
                                                                                                     de.adorsys.psd2.xs2a.core.pis.PaymentAuthorisationType authorisationType)

Gets SCA approach from the authorisation by authorisation ID and authorisation type

Parameters:

authorisationId - String representation of the authorisation identifier

authorisationType - Type of authorisation

Returns:

SCA approach of the authorisation