de.adorsys.ledgers.middleware.api.service

Interface MiddlewarePaymentService

public interface MiddlewarePaymentService

Method Summary

Modifier and Type	Method and Description
SCAPaymentResponseTO	authorizeCancelPayment(String paymentId, String cancellationId, String authCode)
SCAPaymentResponseTO	authorizePayment(String paymentId, String authorisationId, String authCode) PROC: 02c
Object	getPaymentById(String paymentId) Reads and return a payment.
TransactionStatusTO	getPaymentStatusById(String paymentId) PROC: 04
String	iban(String paymentId)
<T> SCAPaymentResponseTO	initiatePayment(T payment, PaymentTypeTO paymentType) PROC:01 Initiates a payment.
SCAPaymentResponseTO	initiatePaymentCancellation(String paymentId) Checks the possibility of payment cancellation
SCAPaymentResponseTO	loadSCAForCancelPaymentData(String paymentId, String cancellationId)
SCAPaymentResponseTO	loadSCAForPaymentData(String paymentId, String authorisationId)
SCAPaymentResponseTO	selectSCAMethodForCancelPayment(String paymentId, String cancellationId, String scaMethodId)
SCAPaymentResponseTO	selectSCAMethodForPayment(String paymentId, String authorisationId, String scaMethodId)

Method Detail

initiatePayment

<T> SCAPaymentResponseTO initiatePayment(T payment,
                                         PaymentTypeTO paymentType)
                                  throws AccountNotFoundMiddlewareException,
                                         NoAccessMiddlewareException,
                                         PaymentWithIdMiddlewareException

PROC:01 Initiates a payment. Called by the channel layer.

This call sets the status RCVD

Parameters:

payment - : the payment object

paymentType - : the payment type

Returns:

: the sca response object.

Throws:

AccountNotFoundMiddlewareException - : account non existant.

NoAccessMiddlewareException - : missing permissions

PaymentWithIdMiddlewareException - : payment with given id exist.

authorizePayment

SCAPaymentResponseTO authorizePayment(String paymentId,
                                      String authorisationId,
                                      String authCode)
                               throws SCAOperationNotFoundMiddlewareException,
                                      SCAOperationValidationMiddlewareException,
                                      SCAOperationExpiredMiddlewareException,
                                      SCAOperationUsedOrStolenMiddlewareException,
                                      PaymentNotFoundMiddlewareException

PROC: 02c

This is called when the user enters the received code.

Parameters:

paymentId - : the payment id

authorisationId - : the authorization id

authCode - : the auth code.

Returns:

: auth response.

Throws:

SCAOperationNotFoundMiddlewareException - : not found

SCAOperationValidationMiddlewareException - : not valid

SCAOperationExpiredMiddlewareException - : expired

SCAOperationUsedOrStolenMiddlewareException - : malicious

PaymentNotFoundMiddlewareException - : payment not found.

getPaymentStatusById

TransactionStatusTO getPaymentStatusById(String paymentId)
                                  throws PaymentNotFoundMiddlewareException

PROC: 04

Read the status of a payment. Can be called repetitively after initiation of a payment.

Parameters:

paymentId - : the payment id

Returns:

: the transaction status

Throws:

PaymentNotFoundMiddlewareException - : payment with id not found.

getPaymentById

Object getPaymentById(String paymentId)
               throws PaymentNotFoundMiddlewareException

Reads and return a payment.

Parameters:

paymentId - : the payment id

Returns:

the payment

Throws:

PaymentNotFoundMiddlewareException

initiatePaymentCancellation

SCAPaymentResponseTO initiatePaymentCancellation(String paymentId)
                                          throws PaymentNotFoundMiddlewareException,
                                                 PaymentProcessingMiddlewareException

Checks the possibility of payment cancellation

Parameters:

paymentId - : the payment id

Returns:

: the auth response object.

Throws:

PaymentNotFoundMiddlewareException - : not found

PaymentProcessingMiddlewareException - : processing

iban

String iban(String paymentId)

loadSCAForPaymentData

SCAPaymentResponseTO loadSCAForPaymentData(String paymentId,
                                           String authorisationId)
                                    throws PaymentNotFoundMiddlewareException,
                                           SCAOperationExpiredMiddlewareException

Throws:

PaymentNotFoundMiddlewareException

SCAOperationExpiredMiddlewareException

selectSCAMethodForPayment

SCAPaymentResponseTO selectSCAMethodForPayment(String paymentId,
                                               String authorisationId,
                                               String scaMethodId)
                                        throws PaymentNotFoundMiddlewareException,
                                               SCAMethodNotSupportedMiddleException,
                                               UserScaDataNotFoundMiddlewareException,
                                               SCAOperationValidationMiddlewareException,
                                               SCAOperationNotFoundMiddlewareException

Throws:

PaymentNotFoundMiddlewareException

SCAMethodNotSupportedMiddleException

UserScaDataNotFoundMiddlewareException

SCAOperationValidationMiddlewareException

SCAOperationNotFoundMiddlewareException

loadSCAForCancelPaymentData

SCAPaymentResponseTO loadSCAForCancelPaymentData(String paymentId,
                                                 String cancellationId)
                                          throws PaymentNotFoundMiddlewareException,
                                                 SCAOperationExpiredMiddlewareException

Throws:

PaymentNotFoundMiddlewareException

SCAOperationExpiredMiddlewareException

selectSCAMethodForCancelPayment

SCAPaymentResponseTO selectSCAMethodForCancelPayment(String paymentId,
                                                     String cancellationId,
                                                     String scaMethodId)
                                              throws PaymentNotFoundMiddlewareException,
                                                     SCAMethodNotSupportedMiddleException,
                                                     UserScaDataNotFoundMiddlewareException,
                                                     SCAOperationValidationMiddlewareException,
                                                     SCAOperationNotFoundMiddlewareException

Throws:

PaymentNotFoundMiddlewareException

SCAMethodNotSupportedMiddleException

UserScaDataNotFoundMiddlewareException

SCAOperationValidationMiddlewareException

SCAOperationNotFoundMiddlewareException

authorizeCancelPayment

SCAPaymentResponseTO authorizeCancelPayment(String paymentId,
                                            String cancellationId,
                                            String authCode)
                                     throws SCAOperationNotFoundMiddlewareException,
                                            SCAOperationValidationMiddlewareException,
                                            SCAOperationExpiredMiddlewareException,
                                            SCAOperationUsedOrStolenMiddlewareException,
                                            PaymentNotFoundMiddlewareException

Throws:

SCAOperationNotFoundMiddlewareException

SCAOperationValidationMiddlewareException

SCAOperationExpiredMiddlewareException

SCAOperationUsedOrStolenMiddlewareException

PaymentNotFoundMiddlewareException