atg.payment.instorepayment

Interface InStorePaymentProcessor

All Known Implementing Classes:

InStorePaymentProcessorImpl

public interface InStorePaymentProcessor

This class defines an interface for in store payment processing. Any class which implements this interface needs to provide an implementation for all the methods, authorize, debit, and credit.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Method Summary

Methods

Modifier and Type	Method and Description
PaymentStatus	authorize(InStorePaymentInfo pInStorePaymentInfo) Authorize the use of in store payment.
PaymentStatus	credit(InStorePaymentInfo pInStorePaymentInfo) Process refunds/credits on payments made by in store payment as a new order
PaymentStatus	credit(InStorePaymentInfo pInStorePaymentInfo, PaymentStatus pStatus) Process refunds/credits on payments made by in store payment.
PaymentStatus	debit(InStorePaymentInfo pInStorePaymentInfo, PaymentStatus pStatus) Process payment by in store payment.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

authorize

PaymentStatus authorize(InStorePaymentInfo pInStorePaymentInfo)

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

Parameters:

pInStorePaymentInfo - the InStorePaymentInfo that contains authorization data

Returns:

a PaymentStatus object detailing the results of the authorization

debit

PaymentStatus debit(InStorePaymentInfo pInStorePaymentInfo,
                  PaymentStatus pStatus)

Process payment by in store payment.

Parameters:

pInStorePaymentInfo - the InStorePaymentInfo 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(InStorePaymentInfo pInStorePaymentInfo,
                   PaymentStatus pStatus)

Process refunds/credits on payments made by in store payment.

Parameters:

pInStorePaymentInfo - the InStorePaymentInfo 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(InStorePaymentInfo pInStorePaymentInfo)

Process refunds/credits on payments made by in store payment as a new order

Parameters:

pInStorePaymentInfo - the InStorePaymentInfo that contains credit data

Returns:

a PaymentStatus object detailing the results of the credit