All Superinterfaces:

Service

All Known Subinterfaces:

ExternalPaymentServiceLocal

All Known Implementing Classes:

ExternalPaymentServiceImpl, ExternalPaymentServiceSecurity
```
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.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`cancel(@NotNull ExternalPaymentActionDTO params)`	Cancels an external payment
`ExternalPaymentData`	`getData(@NotNull Long id)`	Returns data about an external payment
`PerformExternalPaymentData`	`getExternalPaymentData(@NotNull InternalAccountOwner from)`	Returns data used to prepare an external payment matching the given arguments
`PerformExternalPaymentTypeData`	`getExternalPaymentTypeData(@NotNull InternalAccountOwner from, @NotNull TransferTypeVO transferType)`	Returns the data related to a payment type for an external payment
`ExternalPaymentVO`	`perform(@NotNull PerformExternalPaymentDTO parameters)`	Performs an external payment.
`ExternalPaymentPreviewVO`	`preview(@NotNull PerformExternalPaymentDTO parameters)`	Previews an external payment to be performed

Method Detail

cancel

void cancel(@NotNull
            @NotNull ExternalPaymentActionDTO params)
     throws FrameworkException

Cancels an external payment

Throws:: FrameworkException

getData

ExternalPaymentData getData(@NotNull
                            @NotNull Long id)
                     throws FrameworkException

Returns data about an external payment

Throws:: FrameworkException

getExternalPaymentData

PerformExternalPaymentData getExternalPaymentData(@NotNull
                                                  @NotNull InternalAccountOwner from)
                                           throws FrameworkException

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

Throws:: FrameworkException

getExternalPaymentTypeData

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

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

Throws:: FrameworkException

perform

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

Performs an external payment. Returns the resulting transaction information.

Throws:: TransferException; PasswordException; FrameworkException

preview

ExternalPaymentPreviewVO preview(@NotNull
                                 @NotNull PerformExternalPaymentDTO parameters)
                          throws FrameworkException

Previews an external payment to be performed

Throws:: FrameworkException

Interface ExternalPaymentService