Package org.cyclos.services.banking

Interface TransferService

All Superinterfaces:

Service

All Known Subinterfaces:

TransferServiceLocal

public interface TransferService
extends Service

Service which allows access to transfers and scheduled payments. Not to confuse with PaymentService, which is used to perform the payments.

Field Summary

Fields

Modifier and Type	Field	Description
static BigDecimal	MAX_TRANSFER_AMOUNT_EXCLUSIVE	The maximum amount of a transfers, exclusive.
static int	MAX_TRANSFER_AMOUNT_INTEGERS	The power of 10 for .

Method Summary

Modifier and Type	Method	Description
Long	chargeback(@NotNull TransferActionDTO params)	Performs the chargeback for the given transfer, returning the chargeback transfer's id. A chargeback transfer has the same (positive) amount of the original and the from / to swapped, i.e., the receiver of the original transfer becomes the payer of the chargeback and the payer becomes the recevier. Transfers having a parent transfer, i.e.
FileInfo	exportTransfer(ExportFormatVO format, TransferVO transfer)	Exports the given transfer to file
TransferData	getData(@NotNull TransferVO vo)	Returns details data for a transfer
TransferVO	load(@NotNull Long id)	Returns a transfer by id, or throws EntityNotFoundException if not found
TransferVO	loadByTransactionNumber(@NotNull String transactionNumber)	Returns a transfer by transaction number, or throws EntityNotFoundException if not found

Field Detail

MAX_TRANSFER_AMOUNT_INTEGERS

static final int MAX_TRANSFER_AMOUNT_INTEGERS

The power of 10 for .

See Also:

Constant Field Values

MAX_TRANSFER_AMOUNT_EXCLUSIVE

static final BigDecimal MAX_TRANSFER_AMOUNT_EXCLUSIVE

The maximum amount of a transfers, exclusive. The actual max amount is less than this value, with the decimal digits defined by the currency.

Method Detail

chargeback

Long chargeback(@NotNull
                @NotNull TransferActionDTO params)
         throws FrameworkException,
                TransferException

Performs the chargeback for the given transfer, returning the chargeback transfer's id.
A chargeback transfer has the same (positive) amount of the original and the from / to swapped, i.e., the receiver of the original transfer becomes the payer of the chargeback and the payer becomes the recevier.
Transfers having a parent transfer, i.e. those generated by a fee, can not be charged back directly, only the root transfer can.
A chargeback can ignore the account limits, if the transfer type allows it.

Throws:

IllegalActionException - When the given transfer has already been charged back, it's a chargeback itself, or it's a child

InsufficientBalanceException - When the source account of the chargeback transfer (i.e., the destination account of the original), or source account for any generated fee is limited and had insufficient balance for such a payment

UpperCreditLimitReachedException - When the destination account of the chargeback transfer (i.e., the source account of the original), or destination account for any generated fee is limited and would have more balance than the allowed maximum

FrameworkException

TransferException

exportTransfer

FileInfo exportTransfer(ExportFormatVO format,
                        TransferVO transfer)
                 throws FrameworkException

Exports the given transfer to file

Throws:

FrameworkException

getData

TransferData getData(@NotNull
                     @NotNull TransferVO vo)
              throws FrameworkException

Returns details data for a transfer

Throws:

FrameworkException

load

TransferVO load(@NotNull
                @NotNull Long id)
         throws FrameworkException

Returns a transfer by id, or throws EntityNotFoundException if not found

Throws:

FrameworkException

loadByTransactionNumber

TransferVO loadByTransactionNumber(@NotNull
                                   @NotNull String transactionNumber)
                            throws FrameworkException

Returns a transfer by transaction number, or throws EntityNotFoundException if not found

Throws:

FrameworkException