org.cyclos.services.banking

Interface PaymentRequestService

All Superinterfaces:

Service

public interface PaymentRequestService
extends Service

Service interface to perform payment requests and for searching and retrieve information about payment requests.

Author:

luis

See Also:

TransactionService

Method Summary

Modifier and Type	Method and Description
PaymentRequestVO	accept(AcceptPaymentRequestDTO params) Accepts a payment request.
void	cancel(PaymentRequestActionDTO params) Cancels a payment request (as payee)
void	deny(PaymentRequestActionDTO params) Denies a payment request (as payer)
SerializableInputStream	exportPaymentRequestsToCSV(PaymentRequestOverviewQuery query) Generates a CSV with the query result listing the payment requests
PaymentRequestData	getData(java.lang.Long id) Returns data about a payment request
RequestPaymentData	getRequestData(InternalAccountOwner payee, InternalAccountOwner payer) Returns data used to request a payment
RequestPaymentPayerData	getRequestPaymentPayerData(InternalAccountOwner payee, InternalAccountOwner payer) Returns data used to request a payment from a specific owner
RequestPaymentTypeData	getRequestPaymentTypeData(InternalAccountOwner payee, InternalAccountOwner payer, TransferTypeVO transferType) Returns the data for a specific payment type on a payment request from / to the given owners
PaymentRequestSearchOverviewData	getSearchOverviewData() Returns data to perform payment request overview searches.
AcceptPaymentRequestPreviewVO	previewAccept(PaymentRequestVO paymentRequest) Previews the payment which would be performed when accepting the given payment request
PaymentRequestVO	reschedule(AcceptPaymentRequestDTO params) Reschedules a payment request.
Page<PaymentRequestEntryVO>	search(PaymentRequestQuery query) Searches for payment requests according to the given query
Page<PaymentRequestVO>	searchOverview(PaymentRequestOverviewQuery params) Payment request overview search according to the given query.
PaymentRequestVO	send(SendPaymentRequestDTO parameters) Sends a payment request

Method Detail

accept

PaymentRequestVO accept(@NotNull
                        AcceptPaymentRequestDTO params)
                 throws FrameworkException,
                        TransferException

Accepts a payment request. May process immediately or schedule for processing in a future date. Returns the updated payment request information.

Throws:

FrameworkException

TransferException

See Also:

PaymentService.perform(org.cyclos.model.banking.transactions.PerformPaymentDTO)

cancel

void cancel(@NotNull
            PaymentRequestActionDTO params)
     throws FrameworkException

Cancels a payment request (as payee)

Throws:

FrameworkException

deny

void deny(@NotNull
          PaymentRequestActionDTO params)
   throws FrameworkException

Denies a payment request (as payer)

Throws:

FrameworkException

exportPaymentRequestsToCSV

SerializableInputStream exportPaymentRequestsToCSV(@NotNull
                                                   PaymentRequestOverviewQuery query)

Generates a CSV with the query result listing the payment requests

getData

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

Returns data about a payment request

Throws:

FrameworkException

getRequestData

RequestPaymentData getRequestData(InternalAccountOwner payee,
                                  InternalAccountOwner payer)
                           throws FrameworkException

Returns data used to request a payment

Throws:

FrameworkException

getRequestPaymentPayerData

RequestPaymentPayerData getRequestPaymentPayerData(InternalAccountOwner payee,
                                                   InternalAccountOwner payer)
                                            throws FrameworkException

Returns data used to request a payment from a specific owner

Throws:

FrameworkException

getRequestPaymentTypeData

RequestPaymentTypeData getRequestPaymentTypeData(InternalAccountOwner payee,
                                                 InternalAccountOwner payer,
                                                 TransferTypeVO transferType)
                                          throws FrameworkException

Returns the data for a specific payment type on a payment request from / to the given owners

Throws:

FrameworkException

getSearchOverviewData

PaymentRequestSearchOverviewData getSearchOverviewData()
                                                throws FrameworkException

Returns data to perform payment request overview searches.

Throws:

FrameworkException

previewAccept

AcceptPaymentRequestPreviewVO previewAccept(@NotNull
                                            PaymentRequestVO paymentRequest)
                                     throws FrameworkException

Previews the payment which would be performed when accepting the given payment request

Throws:

FrameworkException

reschedule

PaymentRequestVO reschedule(@NotNull
                            AcceptPaymentRequestDTO params)
                     throws FrameworkException

Reschedules a payment request. If the new processing date is null, will process the payment request immediately. Otherwise, changes the processing date for the given one.

Throws:

FrameworkException

search

Page<PaymentRequestEntryVO> search(@NotNull
                                   PaymentRequestQuery query)
                            throws FrameworkException

Searches for payment requests according to the given query

Throws:

FrameworkException

searchOverview

Page<PaymentRequestVO> searchOverview(@NotNull
                                      PaymentRequestOverviewQuery params)
                               throws FrameworkException

Payment request overview search according to the given query.

Throws:

FrameworkException

send

PaymentRequestVO send(@NotNull
                      SendPaymentRequestDTO parameters)
               throws FrameworkException

Sends a payment request

Throws:

FrameworkException