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, @NotNull CreatePiisConsentRequest request) Creates new PIIS consent.
@NotNull List<de.adorsys.psd2.consent.api.piis.CmsPiisConsent>	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,
                               @NotNull
                               @NotNull CreatePiisConsentRequest request)

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

Parameters:

psuIdData - PSU credentials data

request - Request with all information for creating PIIS consent.

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.consent.api.piis.CmsPiisConsent> 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