de.adorsys.psd2.consent.api.service

Interface PisCommonPaymentService

public interface PisCommonPaymentService

PisCommonPaymentService without any encryption/decryption. Should not be used in XS2A directly.

See Also:

PisCommonPaymentServiceBase, PisCommonPaymentServiceEncrypted

Method Summary

Modifier and Type	Method and Description
CmsResponse<de.adorsys.psd2.consent.api.pis.CreatePisCommonPaymentResponse>	createCommonPayment(PisPaymentInfo request)
CmsResponse<PisCommonPaymentResponse>	getCommonPaymentById(String paymentId) Reads full information of pis payment by payment identifier
CmsResponse<de.adorsys.psd2.xs2a.core.pis.TransactionStatus>	getPisCommonPaymentStatusById(String paymentId) Retrieves common payment status from pis payment by payment identifier
CmsResponse<List<de.adorsys.psd2.xs2a.core.psu.PsuIdData>>	getPsuDataListByPaymentId(String paymentId) Get information about PSU list by payment identifier
CmsResponse<CmsResponse.VoidResponse>	updateCommonPayment(PisCommonPaymentRequest request, String paymentId) Updates PIS payment data and stores it into database
CmsResponse<Boolean>	updateCommonPaymentStatusById(String paymentId, de.adorsys.psd2.xs2a.core.pis.TransactionStatus status) Updates pis payment status by payment identifier
CmsResponse<Boolean>	updateMultilevelSca(String paymentId, boolean multilevelScaRequired) Updates multilevelScaRequired and stores changes into database

Method Detail

createCommonPayment

CmsResponse<de.adorsys.psd2.consent.api.pis.CreatePisCommonPaymentResponse> createCommonPayment(PisPaymentInfo request)

getPisCommonPaymentStatusById

CmsResponse<de.adorsys.psd2.xs2a.core.pis.TransactionStatus> getPisCommonPaymentStatusById(String paymentId)

Retrieves common payment status from pis payment by payment identifier

Parameters:

paymentId - String representation of pis payment identifier

Returns:

Information about the status of a common payment

getCommonPaymentById

CmsResponse<PisCommonPaymentResponse> getCommonPaymentById(String paymentId)

Reads full information of pis payment by payment identifier

Parameters:

paymentId - String representation of pis payment identifier

Returns:

Response containing full information about pis payment

updateCommonPaymentStatusById

CmsResponse<Boolean> updateCommonPaymentStatusById(String paymentId,
                                                   de.adorsys.psd2.xs2a.core.pis.TransactionStatus status)

Updates pis payment status by payment identifier

Parameters:

paymentId - String representation of pis payment identifier

status - new payment status

Returns:

Response containing result of status changing

updateCommonPayment

CmsResponse<CmsResponse.VoidResponse> updateCommonPayment(PisCommonPaymentRequest request,
                                                          String paymentId)

Updates PIS payment data and stores it into database

Parameters:

request - PIS payment request for update payment data

paymentId - Payment ID

updateMultilevelSca

CmsResponse<Boolean> updateMultilevelSca(String paymentId,
                                         boolean multilevelScaRequired)

Updates multilevelScaRequired and stores changes into database

Parameters:

paymentId - Payment ID

multilevelScaRequired - new value for boolean multilevel sca required

getPsuDataListByPaymentId

CmsResponse<List<de.adorsys.psd2.xs2a.core.psu.PsuIdData>> getPsuDataListByPaymentId(String paymentId)

Get information about PSU list by payment identifier

Parameters:

paymentId - String representation of the payment identifier

Returns:

Response containing information about PSU