org.cyclos.services.banking

Interface ExternalPaymentService

All Superinterfaces:

Service

public interface ExternalPaymentService
extends Service

Service interface to perform external payments and for searching and retrieving information about an external payment. An external payment is a payment done to an external user (or a user that is not yet registered). The external payments remain pending until the destination user registers in the system.

Author:

jcomas

Method Summary

Modifier and Type	Method and Description
void	cancel(ExternalPaymentActionDTO params) Cancels an external payment
ExternalPaymentData	getData(java.lang.Long id) Returns data about an external payment
PerformExternalPaymentData	getExternalPaymentData(InternalAccountOwner from) Returns data used to prepare an external payment matching the given arguments
PerformExternalPaymentTypeData	getExternalPaymentTypeData(InternalAccountOwner from, TransferTypeVO transferType) Returns the data related to a payment type for an external payment
ExternalPaymentVO	perform(PerformExternalPaymentDTO parameters) Performs an external payment.
ExternalPaymentPreviewVO	preview(PerformExternalPaymentDTO parameters) Previews an external payment to be performed
Page<ExternalPaymentEntryVO>	search(ExternalPaymentQuery query) Searches for external payments according to the given query

Method Detail

cancel

void cancel(@NotNull
            ExternalPaymentActionDTO params)
     throws FrameworkException

Cancels an external payment

Throws:

FrameworkException

getData

ExternalPaymentData getData(@NotNull
                            java.lang.Long id)
                     throws FrameworkException

Returns data about an external payment

Throws:

FrameworkException

getExternalPaymentData

PerformExternalPaymentData getExternalPaymentData(@NotNull
                                                  InternalAccountOwner from)
                                           throws FrameworkException

Returns data used to prepare an external payment matching the given arguments

Throws:

FrameworkException

getExternalPaymentTypeData

PerformExternalPaymentTypeData getExternalPaymentTypeData(@NotNull
                                                          InternalAccountOwner from,
                                                          @NotNull
                                                          TransferTypeVO transferType)
                                                   throws FrameworkException

Returns the data related to a payment type for an external payment

Throws:

FrameworkException

perform

ExternalPaymentVO perform(@NotNull
                          PerformExternalPaymentDTO parameters)
                   throws TransferException,
                          PasswordException,
                          FrameworkException

Performs an external payment. Returns the resulting transaction information.

Throws:

TransferException

PasswordException

FrameworkException

preview

ExternalPaymentPreviewVO preview(@NotNull
                                 PerformExternalPaymentDTO parameters)
                          throws FrameworkException

Previews an external payment to be performed

Throws:

FrameworkException

search

Page<ExternalPaymentEntryVO> search(@NotNull
                                    ExternalPaymentQuery query)
                             throws FrameworkException

Searches for external payments according to the given query

Throws:

FrameworkException