de.adorsys.psd2.consent.api.service

Interface PisConsentService

public interface PisConsentService

Method Summary

Modifier and Type	Method and Description
Optional<CreatePisConsentAuthorisationResponse>	createAuthorization(String paymentId, CmsAuthorisationType authorizationType, de.adorsys.psd2.xs2a.core.psu.PsuIdData psuData) Creates consent authorization
Optional<CreatePisConsentAuthorisationResponse>	createAuthorizationCancellation(String paymentId, CmsAuthorisationType authorizationType, de.adorsys.psd2.xs2a.core.psu.PsuIdData psuData) Creates consent authorization cancellation
Optional<CreatePisConsentResponse>	createPaymentConsent(PisConsentRequest request)
Optional<List<String>>	getAuthorisationsByPaymentId(String paymentId, CmsAuthorisationType authorisationType) Gets list of payment authorisation IDs by payment ID and authorisation type
Optional<PisConsentResponse>	getConsentById(String consentId) Reads full information of pis consent by consent identifier
Optional<de.adorsys.psd2.xs2a.core.consent.ConsentStatus>	getConsentStatusById(String consentId) Retrieves consent status from pis consent by consent identifier
Optional<String>	getDecryptedId(String encryptedId) Gets original decrypted Id from encrypted string
Optional<GetPisConsentAuthorisationResponse>	getPisConsentAuthorisationById(String authorisationId) Get information about Authorisation by authorisation identifier
Optional<GetPisConsentAuthorisationResponse>	getPisConsentCancellationAuthorisationById(String cancellationId) Get information about Authorisation by cancellation identifier
Optional<de.adorsys.psd2.xs2a.core.psu.PsuIdData>	getPsuDataByConsentId(String consentId) Get information about PSU by consent identifier
Optional<de.adorsys.psd2.xs2a.core.psu.PsuIdData>	getPsuDataByPaymentId(String paymentId) Get information about PSU by payment identifier
Optional<UpdatePisConsentPsuDataResponse>	updateConsentAuthorisation(String authorisationId, UpdatePisConsentPsuDataRequest request) Updates consent authorization
Optional<UpdatePisConsentPsuDataResponse>	updateConsentCancellationAuthorisation(String authorizationId, UpdatePisConsentPsuDataRequest request) Updates consent cancellation authorization
Optional<Boolean>	updateConsentStatusById(String consentId, de.adorsys.psd2.xs2a.core.consent.ConsentStatus status) Updates pis consent status by consent identifier
void	updatePaymentConsent(PisConsentRequest request, String consentId) Updates PIS consent payment data and stores it into database

Method Detail

createPaymentConsent

Optional<CreatePisConsentResponse> createPaymentConsent(PisConsentRequest request)

getConsentStatusById

Optional<de.adorsys.psd2.xs2a.core.consent.ConsentStatus> getConsentStatusById(String consentId)

Retrieves consent status from pis consent by consent identifier

Parameters:

consentId - String representation of pis consent identifier

Returns:

Information about the status of a consent

getConsentById

Optional<PisConsentResponse> getConsentById(String consentId)

Reads full information of pis consent by consent identifier

Parameters:

consentId - String representation of pis consent identifier

Returns:

Response containing full information about pis consent

updateConsentStatusById

Optional<Boolean> updateConsentStatusById(String consentId,
                                          de.adorsys.psd2.xs2a.core.consent.ConsentStatus status)

Updates pis consent status by consent identifier

Parameters:

consentId - String representation of pis consent identifier

status - new consent status

Returns:

Response containing result of status changing

getDecryptedId

Optional<String> getDecryptedId(String encryptedId)

Gets original decrypted Id from encrypted string

Parameters:

encryptedId - id to be decrypted

Returns:

Response containing original decrypted Id

createAuthorization

Optional<CreatePisConsentAuthorisationResponse> createAuthorization(String paymentId,
                                                                    CmsAuthorisationType authorizationType,
                                                                    de.adorsys.psd2.xs2a.core.psu.PsuIdData psuData)

Creates consent authorization

Parameters:

paymentId - String representation of the payment identifier

authorizationType - Type of authorisation

psuData - Information about PSU

Returns:

Response containing authorization id

createAuthorizationCancellation

Optional<CreatePisConsentAuthorisationResponse> createAuthorizationCancellation(String paymentId,
                                                                                CmsAuthorisationType authorizationType,
                                                                                de.adorsys.psd2.xs2a.core.psu.PsuIdData psuData)

Creates consent authorization cancellation

Parameters:

paymentId - String representation of the payment identifier

authorizationType - Type of authorisation

psuData - Information about PSU

Returns:

Response containing authorization id

updateConsentAuthorisation

Optional<UpdatePisConsentPsuDataResponse> updateConsentAuthorisation(String authorisationId,
                                                                     UpdatePisConsentPsuDataRequest request)

Updates consent 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

updateConsentCancellationAuthorisation

Optional<UpdatePisConsentPsuDataResponse> updateConsentCancellationAuthorisation(String authorizationId,
                                                                                 UpdatePisConsentPsuDataRequest request)

Updates consent 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

updatePaymentConsent

void updatePaymentConsent(PisConsentRequest request,
                          String consentId)

Updates PIS consent payment data and stores it into database

Parameters:

request - PIS consent request for update payment data

consentId - Consent ID

getPisConsentAuthorisationById

Optional<GetPisConsentAuthorisationResponse> getPisConsentAuthorisationById(String authorisationId)

Get information about Authorisation by authorisation identifier

Parameters:

authorisationId - String representation of the authorisation identifier

Returns:

Response containing information about Authorisation

getPisConsentCancellationAuthorisationById

Optional<GetPisConsentAuthorisationResponse> getPisConsentCancellationAuthorisationById(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,
                                                    CmsAuthorisationType 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

getPsuDataByPaymentId

Optional<de.adorsys.psd2.xs2a.core.psu.PsuIdData> getPsuDataByPaymentId(String paymentId)

Get information about PSU by payment identifier

Parameters:

paymentId - String representation of the payment identifier

Returns:

Response containing information about PSU

getPsuDataByConsentId

Optional<de.adorsys.psd2.xs2a.core.psu.PsuIdData> getPsuDataByConsentId(String consentId)

Get information about PSU by consent identifier

Parameters:

consentId - String representation of pis consent identifier

Returns:

Response containing information about PSU