de.adorsys.psd2.xs2a.service.authorization.pis

Interface PisScaAuthorisationService

All Superinterfaces:

ScaApproachServiceTypeProvider

All Known Implementing Classes:

DecoupledPisScaAuthorisationService, EmbeddedPisScaAuthorisationService, OauthPisScaAuthorisationService, RedirectPisScaAuthorisationService

public interface PisScaAuthorisationService
extends ScaApproachServiceTypeProvider

Method Summary

Modifier and Type	Method and Description
Optional<Xs2aCreatePisAuthorisationResponse>	createCommonPaymentAuthorisation(String paymentId, PaymentType paymentType, PsuIdData psuData) Creates authorisation for a payment
Optional<Xs2aCreatePisCancellationAuthorisationResponse>	createCommonPaymentCancellationAuthorisation(String paymentId, PaymentType paymentType, PsuIdData psuData) Creates authorisation cancellation for the payment
Optional<ScaStatus>	getAuthorisationScaStatus(String paymentId, String authorisationId) Gets SCA status of authorisation
Optional<Xs2aAuthorisationSubResources>	getAuthorisationSubResources(String paymentId) Gets authorisation sub resources
Optional<ScaStatus>	getCancellationAuthorisationScaStatus(String paymentId, String cancellationId) Gets SCA status of cancellation authorisation
Optional<Xs2aPaymentCancellationAuthorisationSubResource>	getCancellationAuthorisationSubResources(String paymentId) Gets authorisation cancellation sub resources
void	updateAuthorisation(UpdateAuthorisationRequest request, AuthorisationProcessorResponse response)
void	updateCancellationAuthorisation(UpdateAuthorisationRequest request, AuthorisationProcessorResponse response)
Xs2aUpdatePisCommonPaymentPsuDataResponse	updateCommonPaymentCancellationPsuData(Xs2aUpdatePisCommonPaymentPsuDataRequest request) Updates cancellation authorisation for the payment
Xs2aUpdatePisCommonPaymentPsuDataResponse	updateCommonPaymentPsuData(Xs2aUpdatePisCommonPaymentPsuDataRequest request) Updates authorisation for the payment

Methods inherited from interface de.adorsys.psd2.xs2a.service.authorization.ScaApproachServiceTypeProvider

getScaApproachServiceType

Method Detail

createCommonPaymentAuthorisation

Optional<Xs2aCreatePisAuthorisationResponse> createCommonPaymentAuthorisation(String paymentId,
                                                                              PaymentType paymentType,
                                                                              PsuIdData psuData)

Creates authorisation for a payment

Parameters:

paymentId - ASPSP identifier of a payment

paymentType - Type of payment

psuData - PsuIdData container of authorisation data about PSU

Returns:

create payment authorisation response

updateCommonPaymentPsuData

Xs2aUpdatePisCommonPaymentPsuDataResponse updateCommonPaymentPsuData(Xs2aUpdatePisCommonPaymentPsuDataRequest request)

Updates authorisation for the payment

Parameters:

request - Provides transporting data when updating consent psu data

Returns:

update payment authorisation response

updateAuthorisation

void updateAuthorisation(UpdateAuthorisationRequest request,
                         AuthorisationProcessorResponse response)

updateCancellationAuthorisation

void updateCancellationAuthorisation(UpdateAuthorisationRequest request,
                                     AuthorisationProcessorResponse response)

createCommonPaymentCancellationAuthorisation

Optional<Xs2aCreatePisCancellationAuthorisationResponse> createCommonPaymentCancellationAuthorisation(String paymentId,
                                                                                                      PaymentType paymentType,
                                                                                                      PsuIdData psuData)

Creates authorisation cancellation for the payment

Parameters:

paymentId - ASPSP identifier of a payment

paymentType - Type of payment

psuData - PsuIdData container of authorisation data about PSU

Returns:

create payment cancellation authorisation response

getCancellationAuthorisationSubResources

Optional<Xs2aPaymentCancellationAuthorisationSubResource> getCancellationAuthorisationSubResources(String paymentId)

Gets authorisation cancellation sub resources

Parameters:

paymentId - ASPSP identifier of a payment

Returns:

authorisation cancellation sub resources

updateCommonPaymentCancellationPsuData

Xs2aUpdatePisCommonPaymentPsuDataResponse updateCommonPaymentCancellationPsuData(Xs2aUpdatePisCommonPaymentPsuDataRequest request)

Updates cancellation authorisation for the payment

Parameters:

request - Provides transporting data when updating payment psu data

Returns:

update consent authorisation response

getAuthorisationSubResources

Optional<Xs2aAuthorisationSubResources> getAuthorisationSubResources(String paymentId)

Gets authorisation sub resources

Parameters:

paymentId - ASPSP identifier of a payment

Returns:

authorisation sub resources

getAuthorisationScaStatus

Optional<ScaStatus> getAuthorisationScaStatus(String paymentId,
                                              String authorisationId)

Gets SCA status of authorisation

Parameters:

paymentId - ASPSP identifier of the payment, associated with the authorisation

authorisationId - authorisation identifier

Returns:

SCA status

getCancellationAuthorisationScaStatus

Optional<ScaStatus> getCancellationAuthorisationScaStatus(String paymentId,
                                                          String cancellationId)

Gets SCA status of cancellation authorisation

Parameters:

paymentId - ASPSP identifier of the payment, associated with the authorisation

cancellationId - cancellation authorisation identifier

Returns:

SCA status