atg.payment.storecredit

Interface StoreCreditProcessor

All Known Implementing Classes:

StoreCreditProcessorImpl

public interface StoreCreditProcessor

This class defines an interface for store credit processing. It has three methods for submitting transactions to a store credit processing system. They are authorize, debit, and credit. Any class which implements this class must provide implementations for each of these methods.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
StoreCreditStatus	authorize(StoreCreditInfo pStoreCreditInfo) Authorize the store credit
StoreCreditStatus	credit(StoreCreditInfo pStoreCreditInfo) Credit the amount on the store credit without a previous debit.
StoreCreditStatus	credit(StoreCreditInfo pStoreCreditInfo, PaymentStatus pStatus) Credit the amount on the store credit after debiting.
StoreCreditStatus	debit(StoreCreditInfo pStoreCreditInfo, PaymentStatus pStatus) Debit the amount on the store credit after authorization
StoreCreditStatus	expireAuthorization(StoreCreditInfo pStoreCreditInfo) Expire a store credit authorization

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

authorize

StoreCreditStatus authorize(StoreCreditInfo pStoreCreditInfo)

Authorize the store credit

Parameters:

pStoreCreditInfo - the StoreCreditInfo reference which contains all the authorization data

Returns:

a StoreCreditStatus object detailing the results of the authorization

expireAuthorization

StoreCreditStatus expireAuthorization(StoreCreditInfo pStoreCreditInfo)

Expire a store credit authorization

Parameters:

pStoreCreditInfo - the StoreCreditInfo reference which contains all the authorization expiration data

Returns:

a StoreCreditStatus object detailing the results of the authorization

debit

StoreCreditStatus debit(StoreCreditInfo pStoreCreditInfo,
                        PaymentStatus pStatus)

Debit the amount on the store credit after authorization

Parameters:

pStoreCreditInfo - the StoreCreditInfo reference which contains all the debit data

pStatus - the PaymentStatus object which contains information about the transaction. This should be the object which was returned from authorize().

Returns:

a StoreCreditStatus object detailing the results of the debit

credit

StoreCreditStatus credit(StoreCreditInfo pStoreCreditInfo,
                         PaymentStatus pStatus)

Credit the amount on the store credit after debiting.

Parameters:

pStoreCreditInfo - the StoreCreditInfo reference which contains all the credit data

pStatus - the PaymentStatus object which contains information about the transaction. This should be the object which was returned from debit().

Returns:

a StoreCreditStatus object detailing the results of the credit

credit

StoreCreditStatus credit(StoreCreditInfo pStoreCreditInfo)

Credit the amount on the store credit without a previous debit.

Parameters:

pStoreCreditInfo - the StoreCreditInfo reference which contains all the credit data

Returns:

a StoreCreditStatus object detailing the results of the credit