Package org.cyclos.services.banking

Interface EasyInvoiceService

All Superinterfaces:

Service

All Known Subinterfaces:

EasyInvoiceServiceLocal

public interface EasyInvoiceService
extends Service

Service interface to perform direct payments (scheduled and recurring are not supported) originated form an EasyInvoice. An easy invoice is a pre-filled payment to an user.
All methods in this service run through the BuiltInChannel.EASY_INVOICE channel For searching and retrieve information about a payment use the PaymentService.

See Also:

PaymentService

Method Summary

Modifier and Type	Method	Description
SerializableInputStream	barcode(@NotNull EasyInvoiceBarcodeParams params)	Generates a QR-Code image for the given PerformPaymentDTO
EasyInvoiceData	getEasyInvoiceData(PerformPaymentDTO params)	Returns data for an easy invoice after logging in.
PaymentVO	perform(@NotNull PerformPaymentDTO parameters)	Same as PaymentService.perform(PerformPaymentDTO) but through the BuiltInChannel.EASY_INVOICE channel
PrepareEasyInvoiceData	prepareEasyInvoice(PrepareEasyInvoiceParams params)	Returns data for displaying details of an easy invoice while still as guest.
PaymentPreviewVO	preview(@NotNull PerformPaymentDTO parameters)	Previews a payment to be performed
void	validate(@NotNull PerformPaymentDTO parameters)	Validates the parameters to perform a payment without actually performing the payment.

Method Detail

barcode

SerializableInputStream barcode(@NotNull
                                @NotNull EasyInvoiceBarcodeParams params)
                         throws FrameworkException

Generates a QR-Code image for the given PerformPaymentDTO

Throws:

FrameworkException

getEasyInvoiceData

EasyInvoiceData getEasyInvoiceData(PerformPaymentDTO params)
                            throws FrameworkException

Returns data for an easy invoice after logging in. Minimally, a owner user is required. The amount either is not specified or a currency must be resolved, in the same way as prepareEasyInvoice(PrepareEasyInvoiceParams) The resulting data will contain the resolved read-only custom field values. The resulting PerformPaymentTypeData will contain the custom fields for the missing values.

Throws:

FrameworkException

perform

PaymentVO perform(@NotNull
                  @NotNull PerformPaymentDTO parameters)
           throws TransferException,
                  FrameworkException

Same as PaymentService.perform(PerformPaymentDTO) but through the BuiltInChannel.EASY_INVOICE channel

Throws:

TransferException

FrameworkException

prepareEasyInvoice

PrepareEasyInvoiceData prepareEasyInvoice(PrepareEasyInvoiceParams params)
                                   throws FrameworkException,
                                          RemoteAddressBlockedException

Returns data for displaying details of an easy invoice while still as guest. Minimally, the owner user is required. If an amount is specified, it is required that a single currency is resolved. This can be either because:

• A payment type was specified
• A currency was specified
• The destination user has a single currency

The resulting user will be returned only if the guest can search / view profile of that group. Without this permission, a null user will be returned. However, if the user is not found, a regular EntityNotFoundException will be thrown.

Throws:

FrameworkException

RemoteAddressBlockedException

preview

PaymentPreviewVO preview(@NotNull
                         @NotNull PerformPaymentDTO parameters)
                  throws FrameworkException

Previews a payment to be performed

Throws:

FrameworkException

validate

void validate(@NotNull
              @NotNull PerformPaymentDTO parameters)
       throws FrameworkException

Validates the parameters to perform a payment without actually performing the payment. Attention: will only validate for required / invalid fields, but will not check for balance, maximum amount per day or other validations that require access to actual accounts.

Throws:

FrameworkException