All Superinterfaces:

Service

All Known Subinterfaces:

PaymentRequestServiceLocal
```
public interface PaymentRequestService
extends Service
```
Service interface to perform payment requests and for searching and retrieve information about payment requests.

See Also:

TransactionService

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`PaymentRequestVO`	`accept(@NotNull AcceptPaymentRequestDTO params)`	Accepts a payment request.
`void`	`cancel(@NotNull PaymentRequestActionDTO params)`	Cancels a payment request (as payee)
`void`	`changeExpirationDate(@NotNull ChangePaymentRequestExpirationDateDTO params)`	Changes the payment request's expiration date as payee, admin or broker only if permissions are granted.
`void`	`deny(@NotNull PaymentRequestActionDTO params)`	Denies a payment request (as payer)
`PaymentRequestData`	`getData(@NotNull Long id)`	Returns data about a payment request
`RequestPaymentData`	`getRequestData(InternalAccountOwner payee, InternalAccountOwner payer, TransferTypeVO paymentType)`	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
`AcceptPaymentRequestPreviewVO`	`previewAccept(@NotNull PaymentRequestVO paymentRequest)`	Previews the payment which would be performed when accepting the given payment request
`PaymentRequestVO`	`reschedule(@NotNull AcceptPaymentRequestDTO params)`	Reschedules a payment request.
`PaymentRequestVO`	`send(@NotNull SendPaymentRequestDTO parameters)`	Sends a payment request

Method Detail

accept
```
PaymentRequestVO accept(@NotNull
                        @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
            @NotNull PaymentRequestActionDTO params)
     throws FrameworkException

Cancels a payment request (as payee)

Throws:: FrameworkException

changeExpirationDate

void changeExpirationDate(@NotNull
                          @NotNull ChangePaymentRequestExpirationDateDTO params)
                   throws FrameworkException

Changes the payment request's expiration date as payee, admin or broker only if permissions are granted.

Throws:: FrameworkException

deny

void deny(@NotNull
          @NotNull PaymentRequestActionDTO params)
   throws FrameworkException

Denies a payment request (as payer)

Throws:: FrameworkException

getData

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

Returns data about a payment request

Throws:: FrameworkException

getRequestData

RequestPaymentData getRequestData(InternalAccountOwner payee,
                                  InternalAccountOwner payer,
                                  TransferTypeVO paymentType)
                           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

previewAccept

AcceptPaymentRequestPreviewVO previewAccept(@NotNull
                                            @NotNull PaymentRequestVO paymentRequest)
                                     throws FrameworkException

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

Throws:: FrameworkException

reschedule
```
PaymentRequestVO reschedule(@NotNull
                            @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

send

PaymentRequestVO send(@NotNull
                      @NotNull SendPaymentRequestDTO parameters)
               throws FrameworkException

Sends a payment request

Throws:: FrameworkException

Interface PaymentRequestService