Module com.aoapps.payments.usaepay

Package com.aoapps.payments.usaepay

Class USAePay

java.lang.Object

com.aoapps.payments.usaepay.USAePay

All Implemented Interfaces:

MerchantServicesProvider

public class USAePay
extends Object
implements MerchantServicesProvider

Provider for the USAePay system.

Configuration parameters:

1. providerId - the unique name of the processor
2. postUrl - the URL used for HTTP POST
3. key - the source key
4. pin (optional) - the pin used for MD5 hash transaction verification

TODO: Get this code listed at http://wiki.usaepay.com/developer/3rdparty

Author:

AO Industries, Inc.

Constructor Summary

Constructors

Constructor	Description
USAePay(String providerId, String postUrl, String key)	Creates a new USAePay provider.
USAePay(String providerId, String postUrl, String key, String pin)	Creates a new USAePay provider.

Method Summary

Modifier and Type	Method	Description
protected static void	addMaxLengthParameter(Map<String,String> request, String name, String value, int maxLength, TransactionResult.ErrorCode errorCode)	Adds a parameter to the request after checking its length.
protected static void	addTrimmedParameter(Map<String,String> request, String name, String value, int maxLength)	Adds a parameter to the request.
AuthorizationResult	authorize(TransactionRequest transactionRequest, CreditCard creditCard)
boolean	canGetTokenizedCreditCards()
boolean	canStoreCreditCards()
CaptureResult	capture(AuthorizationResult authorizationResult)
CreditResult	credit(TransactionRequest transactionRequest, CreditCard creditCard)
void	deleteCreditCard(CreditCard creditCard)
String	getKey()	Gets the source key.
String	getPin()	Gets the PIN used for MD5 request and response validation.
String	getPostUrl()	Gets the post URL.
String	getProviderId()
protected static String	getStreetAddress(String line1, String line2)	Combines the two street address lines into a single String.
Map<String,TokenizedCreditCard>	getTokenizedCreditCards(Map<String,CreditCard> persistedCards, PrintWriter verboseOut, PrintWriter infoOut, PrintWriter warningOut)
SaleResult	sale(TransactionRequest transactionRequest, CreditCard creditCard)
String	storeCreditCard(CreditCard creditCard)
protected Map<String,String>	submitTransaction(Map<String,String> request, boolean testMode)	Submits a transaction (a Map of name/value pairs), and returns the result as a Map of name/value pairs.
void	updateCreditCard(CreditCard creditCard)
void	updateCreditCardExpiration(CreditCard creditCard, byte expirationMonth, short expirationYear)
void	updateCreditCardNumberAndExpiration(CreditCard creditCard, String cardNumber, byte expirationMonth, short expirationYear, String cardCode)
VoidResult	voidTransaction(Transaction transaction)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

USAePay

public USAePay(String providerId,
 String postUrl,
 String key)

Creates a new USAePay provider.

USAePay

public USAePay(String providerId,
 String postUrl,
 String key,
 String pin)

Creates a new USAePay provider.

Method Details

getProviderId

public String getProviderId()

Specified by:

getProviderId in interface MerchantServicesProvider

getPostUrl

public String getPostUrl()

Gets the post URL.

getKey

public String getKey()

Gets the source key.

getPin

public String getPin()

Gets the PIN used for MD5 request and response validation. http://wiki.usaepay.com/developer/transactionapi#source_pin_code

submitTransaction

protected Map<String,String> submitTransaction(Map<String,String> request,
 boolean testMode)
                                        throws ErrorCodeException

Submits a transaction (a Map of name/value pairs), and returns the result as a Map of name/value pairs.

Throws:

ErrorCodeException

addMaxLengthParameter

protected static void addMaxLengthParameter(Map<String,String> request,
 String name,
 String value,
 int maxLength,
 TransactionResult.ErrorCode errorCode)
                                     throws ErrorCodeException

Adds a parameter to the request after checking its length. If longer, throws an ErrorCodeException with the provided TransactionResult.ErrorCode, otherwise appends the value.

Throws:

ErrorCodeException

addTrimmedParameter

protected static void addTrimmedParameter(Map<String,String> request,
 String name,
 String value,
 int maxLength)

Adds a parameter to the request. If the value is too long, the first maxLength characters are used and the rest are discarded.

getStreetAddress

protected static String getStreetAddress(String line1,
 String line2)

Combines the two street address lines into a single String.

sale

public SaleResult sale(TransactionRequest transactionRequest,
 CreditCard creditCard)

Specified by:

sale in interface MerchantServicesProvider

authorize

public AuthorizationResult authorize(TransactionRequest transactionRequest,
 CreditCard creditCard)

Specified by:

authorize in interface MerchantServicesProvider

capture

public CaptureResult capture(AuthorizationResult authorizationResult)

Specified by:

capture in interface MerchantServicesProvider

voidTransaction

public VoidResult voidTransaction(Transaction transaction)

Specified by:

voidTransaction in interface MerchantServicesProvider

credit

public CreditResult credit(TransactionRequest transactionRequest,
 CreditCard creditCard)

Specified by:

credit in interface MerchantServicesProvider

canStoreCreditCards

public boolean canStoreCreditCards()

Specified by:

canStoreCreditCards in interface MerchantServicesProvider

storeCreditCard

public String storeCreditCard(CreditCard creditCard)
                       throws UnsupportedOperationException

Specified by:

storeCreditCard in interface MerchantServicesProvider

Throws:

UnsupportedOperationException

updateCreditCard

public void updateCreditCard(CreditCard creditCard)
                      throws UnsupportedOperationException

Specified by:

updateCreditCard in interface MerchantServicesProvider

Throws:

UnsupportedOperationException

updateCreditCardNumberAndExpiration

public void updateCreditCardNumberAndExpiration(CreditCard creditCard,
 String cardNumber,
 byte expirationMonth,
 short expirationYear,
 String cardCode)
                                         throws UnsupportedOperationException

Specified by:

updateCreditCardNumberAndExpiration in interface MerchantServicesProvider

Throws:

UnsupportedOperationException

updateCreditCardExpiration

public void updateCreditCardExpiration(CreditCard creditCard,
 byte expirationMonth,
 short expirationYear)
                                throws UnsupportedOperationException

Specified by:

updateCreditCardExpiration in interface MerchantServicesProvider

Throws:

UnsupportedOperationException

deleteCreditCard

public void deleteCreditCard(CreditCard creditCard)
                      throws UnsupportedOperationException

Specified by:

deleteCreditCard in interface MerchantServicesProvider

Throws:

UnsupportedOperationException

canGetTokenizedCreditCards

public boolean canGetTokenizedCreditCards()

Specified by:

canGetTokenizedCreditCards in interface MerchantServicesProvider

getTokenizedCreditCards

public Map<String,TokenizedCreditCard> getTokenizedCreditCards(Map<String,CreditCard> persistedCards,
 PrintWriter verboseOut,
 PrintWriter infoOut,
 PrintWriter warningOut)
                                                        throws UnsupportedOperationException

Specified by:

getTokenizedCreditCards in interface MerchantServicesProvider

Throws:

UnsupportedOperationException