Package com.avoka.fc.core.service.payment.reconciliation

Interface IFileBasedReconciliation

public interface IFileBasedReconciliation

Provides an interface to define the contract of behavior that a payment gateway need to support to be able to support a file based reconciliation process.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getCsvConfig(Client client)	Return the hash map of configuration values used to define the structure of the reconciliation file
int	getKeepReconciliationFilesForDays()	Return the configuration parameter 'keepReconciliationFilesForDays'
String	getPaymentServiceCode()	Return the configuration parameter 'paymentServiceCode'
int	getPaymentTransactionLifespanMinutes()	Return the configuration parameter 'paymentTransactionLifespanMinutes'
String	getTestModeNowDate()	Return the configuration parameter 'testModeNowDate'
void	processReconciliationItem(PaymentLog paymentLog, ReconciliationItem reconciliationItem)	This method will process the file reconcilaition item.
PaymentLog	reconciliationIdentifyTransaction(String key)	This method will identify the payment log entry represented by the key in the reconciliation file
void	recordFailedTransaction(PaymentLog paymentLog, String code, String reason)	This method will mark a PaymentLog entry as failed.
void	resolveOutstandingPayments()	Attempt to reconcile any other outstanding payment items

Method Detail

getPaymentTransactionLifespanMinutes

int getPaymentTransactionLifespanMinutes()

Return the configuration parameter 'paymentTransactionLifespanMinutes'

Returns:

the payment transaction lifespan in minutes

getKeepReconciliationFilesForDays

int getKeepReconciliationFilesForDays()

Return the configuration parameter 'keepReconciliationFilesForDays'

Returns:

number of days to keep the reconciliation files

getTestModeNowDate

String getTestModeNowDate()

Return the configuration parameter 'testModeNowDate'

Returns:

the test node now date string

getPaymentServiceCode

String getPaymentServiceCode()

Return the configuration parameter 'paymentServiceCode'

Returns:

the payment service code

getCsvConfig

Map<String,Object> getCsvConfig(Client client)

Return the hash map of configuration values used to define the structure of the reconciliation file

Parameters:

client - the client organization

Returns:

the Map

Since:

4.1.14

processReconciliationItem

void processReconciliationItem(PaymentLog paymentLog,
                               ReconciliationItem reconciliationItem)

This method will process the file reconcilaition item. The result of this will be a reconciled PaymentLog entry (Either successful or in error)

Parameters:

paymentLog - The payment log the reconciliation item represents

reconciliationItem - The object that represents the reconciliation file item

recordFailedTransaction

void recordFailedTransaction(PaymentLog paymentLog,
                             String code,
                             String reason)

This method will mark a PaymentLog entry as failed.

Parameters:

paymentLog - The payment log to update

code - the response code

reason - the failure reason

reconciliationIdentifyTransaction

PaymentLog reconciliationIdentifyTransaction(String key)

This method will identify the payment log entry represented by the key in the reconciliation file

Parameters:

key - The key value in the reconciliation file

Returns:

the identified PaymentLog entry

resolveOutstandingPayments

void resolveOutstandingPayments()

Attempt to reconcile any other outstanding payment items