de.adorsys.psd2.consent.aspsp.api.piis

Interface CmsAspspPiisService

public interface CmsAspspPiisService

Method Summary

Modifier and Type	Method and Description
Optional<String>	createConsent(@NotNull de.adorsys.psd2.xs2a.core.psu.PsuIdData psuIdData, @Nullable de.adorsys.psd2.xs2a.core.tpp.TppInfo tppInfo, @NotNull List<de.adorsys.psd2.xs2a.core.profile.AccountReference> accounts, @NotNull LocalDate validUntil, int allowedFrequencyPerDay) Creates new PIIS consent.
@NotNull List<de.adorsys.psd2.xs2a.core.piis.PiisConsent>	getConsentsForPsu(@NotNull de.adorsys.psd2.xs2a.core.psu.PsuIdData psuIdData, @NotNull String instanceId) Returns a list of PIIS Consent objects by PSU ID
boolean	terminateConsent(@NotNull String consentId, @NotNull String instanceId) Terminates PIIS Consent object by its ID.

Method Detail

createConsent

Optional<String> createConsent(@NotNull
                               @NotNull de.adorsys.psd2.xs2a.core.psu.PsuIdData psuIdData,
                               @Nullable
                               @Nullable de.adorsys.psd2.xs2a.core.tpp.TppInfo tppInfo,
                               @NotNull
                               @NotNull List<de.adorsys.psd2.xs2a.core.profile.AccountReference> accounts,
                               @NotNull
                               @NotNull LocalDate validUntil,
                               int allowedFrequencyPerDay)

Creates new PIIS consent. Consent gets status "Valid".

Parameters:

psuIdData - PSU credentials data

tppInfo - TPP for which the consent will be created. If the value is omitted, the consent will be created for all TPPs. If the TPP info object is present, it must contain authorisation number and authority ID.

accounts - List of accounts for which the consent will be created

validUntil - Consent's expiration date

allowedFrequencyPerDay - Maximum frequency for an access per day

Returns:

Consent id if the consent was created

terminateConsent

boolean terminateConsent(@NotNull
                         @NotNull String consentId,
                         @NotNull
                         @NotNull String instanceId)

Terminates PIIS Consent object by its ID. Consent gets status "Terminated by ASPSP".

Parameters:

consentId - ID of Consent

instanceId - Id of the particular service instance

Returns:

true if consent was found and terminated. false otherwise.

getConsentsForPsu

@NotNull
@NotNull List<de.adorsys.psd2.xs2a.core.piis.PiisConsent> getConsentsForPsu(@NotNull
                                                                                     @NotNull de.adorsys.psd2.xs2a.core.psu.PsuIdData psuIdData,
                                                                                     @NotNull
                                                                                     @NotNull String instanceId)

Returns a list of PIIS Consent objects by PSU ID

Parameters:

psuIdData - PSU credentials data

instanceId - Id of the particular service instance

Returns:

List of PIIS Consent objects corresponding to the given PSU