atg.payment.invoicerequest
Interface InvoiceRequestProcessor

All Known Implementing Classes:

InvoiceRequestProcessorImpl, InvoiceRequestProcessorImpl

public interface InvoiceRequestProcessor

This interface defines a generic payment processor for billing by invoice.

Field Summary

static java.lang.String

CLASS_VERSION

Method Summary

PaymentStatus	authorize(InvoiceRequestInfo pInvoiceInfo) Authorize the use of a invoice for payment.
PaymentStatus	credit(InvoiceRequestInfo pInvoiceInfo) Process refunds/credits on payments made by invoice as a new order
PaymentStatus	credit(InvoiceRequestInfo pInvoiceInfo, PaymentStatus pStatus) Process refunds/credits on payments made by invoice.
PaymentStatus	debit(InvoiceRequestInfo pInvoiceInfo, PaymentStatus pStatus) Process payment by invoice.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

authorize

PaymentStatus authorize(InvoiceRequestInfo pInvoiceInfo)

Authorize the use of a invoice for payment. Implementations that perform tests such as credit checks before placing an order may want to implement them in this method.

Parameters:

pInvoiceRequestInfo - the InvoiceRequestInfo that contains authorization data

Returns:

a PaymentStatus object detailing the results of the authorization

debit

PaymentStatus debit(InvoiceRequestInfo pInvoiceInfo,
                    PaymentStatus pStatus)

Process payment by invoice. Implementation classes will want to perform actual invoice generation and delivery in this method.

Parameters:

pInvoiceRequestInfo - the InvoiceRequestInfo that contains debit data

pStatus - the PaymentStatus object that contains information about the transaction. This will be the object that was returned by the last call to authorize().

Returns:

a PaymentStatus object detailing the results of the debit

credit

PaymentStatus credit(InvoiceRequestInfo pInvoiceInfo,
                     PaymentStatus pStatus)

Process refunds/credits on payments made by invoice.

Parameters:

pInvoiceRequestInfo - the InvoiceRequestInfo that contains credit data

pStatus - the PaymentStatus object that contains information about the transaction. This will be the object that was returned by the last call to debit().

Returns:

a PaymentStatus object detailing the results of the credit

credit

PaymentStatus credit(InvoiceRequestInfo pInvoiceInfo)

Process refunds/credits on payments made by invoice as a new order

Parameters:

pInvoiceRequestInfo - the InvoiceRequestInfo that contains credit data

Returns:

a PaymentStatus object detailing the results of the credit