com.retek.component.payment.integration.storedvaluecard
Interface SynchronousStoredValueCardProcessor


public interface SynchronousStoredValueCardProcessor

An API to be implemented by an adaptor to a third-party stored value card processing system. When processing stored value cards, the system will look for com/retek/component/payment/integration/storedvaluecard/integration.properties in the classpath, and load the class named in the property storedvaluecard.synchronous, which must implement this interface.

This class may be joined in the future by an AsynchronousStoredValueCardProcessor, which will use the same request and response classes.


Method Summary
 StoredValueCardAuthorizationResponse authorize(StoredValueCardAuthorizationRequest request)
          Handles the authorization of a single stored value card.
 StoredValueCardCashoutResponse cashout(StoredValueCardCashoutRequest request)
          Handles the cashout of a single stored value card.
 StoredValueCardInquiryResponse inquiry(StoredValueCardInquiryRequest request)
          Handles the inquiry of a single stored value card.
 void voidAuthorization(StoredValueCardAuthorizationRequest request)
          Handles a void authorization of a single stored value card.
 

Method Detail

authorize

public StoredValueCardAuthorizationResponse authorize(StoredValueCardAuthorizationRequest request)
                                               throws StoredValueCardProcessingException
Handles the authorization of a single stored value card. If the authorization is successful, the Stored Value Card is debited in the external system.

Parameters:
request - - Account number, pin number, and requested authorize amount
Returns:
response - Authorization date, available balance and status
Throws:
StoredValueCardProcessingException - if the system is unable to process the authorization request.

inquiry

public StoredValueCardInquiryResponse inquiry(StoredValueCardInquiryRequest request)
                                       throws StoredValueCardProcessingException
Handles the inquiry of a single stored value card.

Parameters:
request - - Account number
Returns:
response - Available balance, banner ID, card type
Throws:
StoredValueCardProcessingException - if the system is unable to process the inquiry request.

cashout

public StoredValueCardCashoutResponse cashout(StoredValueCardCashoutRequest request)
                                       throws StoredValueCardProcessingException
Handles the cashout of a single stored value card. Should not allow a cashout on a merchandise card.

Parameters:
request - - Account number
Returns:
response - Amount refunded
Throws:
StoredValueCardProcessingException - if the system is unable to process the inquiry request.

voidAuthorization

public void voidAuthorization(StoredValueCardAuthorizationRequest request)
                       throws StoredValueCardProcessingException
Handles a void authorization of a single stored value card. If the void authorization is successful, the Stored Value Card is credited in the external system.

Parameters:
request - - Account number, pin number, and requested void amount
Throws:
StoredValueCardProcessingException - if the system is unable to process the void authorization request.


Copyright © 2005 Retek Inc. All Rights Reserved. - Generated at Fri, 01/21/2005 14:25