Module com.aoapps.payments.api

Package com.aoapps.payments

Class CreditCardProcessor

java.lang.Object

com.aoapps.payments.CreditCardProcessor

public class CreditCardProcessor
extends Object

Processes credit card payments with pluggable merchant services providers and persistence mechanisms.

TODO: Age check methods

TODO: Make sure that no calls result in cross-provider data, like a card stored with on provider being used for transactions on another.

TODO: Provide batch close calls?

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
protected final PersistenceMechanism	persistenceMechanism
protected final MerchantServicesProvider	provider

Constructor Summary

Constructors

Constructor	Description
CreditCardProcessor(MerchantServicesProvider provider, PersistenceMechanism persistenceMechanism)	Creates a new CreditCardProcessor.

Method Summary

Modifier and Type	Method	Description
Transaction	authorize(Principal principal, Group group, TransactionRequest transactionRequest, CreditCard creditCard)	Authorizes a sale.
boolean	canStoreCreditCards()	Queries the provider to see if they support the secure storage of credit cards.
CaptureResult	capture(Principal principal, Transaction transaction)	Captures the funds from a previous call to authorize.
CreditResult	credit(TransactionRequest transactionRequest, CreditCard creditCard)	Requests a credit.
void	deleteCreditCard(Principal principal, CreditCard creditCard)	Deletes the credit card information from the secure storage.
String	getProviderId()	Gets the uniqueId of the provider this processor is using.
Transaction	sale(Principal principal, Group group, TransactionRequest transactionRequest, CreditCard creditCard)	Performs an immediate sale, effectively a combination of authorize and capture.
void	storeCreditCard(Principal principal, Group group, CreditCard creditCard)	Stores a credit card securely for later reuse.
void	synchronizeStoredCards(Principal principal, PrintWriter verboseOut, PrintWriter infoOut, PrintWriter warningOut, boolean dryRun)	Synchronizes any replacement masked card numbers or expiration dates from the provider back into the persistence mechanism.
void	updateCreditCard(Principal principal, CreditCard creditCard)	Updates the credit card details, all except the card number and expiration.
void	updateCreditCardExpiration(Principal principal, CreditCard creditCard, byte expirationMonth, short expirationYear)	Updates the credit card expiration.
void	updateCreditCardNumberAndExpiration(Principal principal, CreditCard creditCard, String cardNumber, byte expirationMonth, short expirationYear, String cardCode)	Updates the credit card number, expiration, and (optionally) card code.
VoidResult	voidTransaction(Principal principal, Transaction transaction)	Voids a previous transaction.

Methods inherited from class java.lang.Object

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

Field Details

provider

protected final MerchantServicesProvider provider

persistenceMechanism

protected final PersistenceMechanism persistenceMechanism

Constructor Details

CreditCardProcessor

public CreditCardProcessor(MerchantServicesProvider provider,
 PersistenceMechanism persistenceMechanism)

Creates a new CreditCardProcessor.

Method Details

getProviderId

public String getProviderId()

Gets the uniqueId of the provider this processor is using.

sale

public Transaction sale(Principal principal,
 Group group,
 TransactionRequest transactionRequest,
 CreditCard creditCard)
                 throws SQLException

Performs an immediate sale, effectively a combination of authorize and capture. The transaction is inserted into the persistence layer first in a PROCESSING state, the provider performs the sale, and then the persistence layer transaction state is changed to the appropriate final state. Thus, any problem or restart will not lose record of the transaction, and the PROCESSING state transaction may be manually resolved.

Parameters:

principal - null is acceptable

group - null is acceptable

transactionRequest - The transaction details for this sale

creditCard - The credit card to charge for this sale. The masked card number and/or expiration might be updated during the sale, and if updated the changes will have already been persisted.

Throws:

SQLException

See Also:

• authorize(java.security.Principal, com.aoapps.lang.security.acl.Group, com.aoapps.payments.TransactionRequest, com.aoapps.payments.CreditCard)
• capture(java.security.Principal, com.aoapps.payments.Transaction)

authorize

public Transaction authorize(Principal principal,
 Group group,
 TransactionRequest transactionRequest,
 CreditCard creditCard)
                      throws SQLException

Authorizes a sale. The funds are reserved but not captured until a later call to capture. The transaction is inserted into the persistence layer first in a PROCESSING state, the provider performs the authorization, and then the persistence layer transaction state is changed to the appropriate final state. Thus, any problem or restart will not lose record of the transaction, and the PROCESSING state transaction may be manually resolved.

Parameters:

principal - null is acceptable

group - null is acceptable

transactionRequest - The transaction details for this sale

creditCard - The credit card to charge for this sale. The masked card number and/or expiration might be updated during the sale, and if updated the changes will have already been persisted.

Throws:

SQLException

See Also:

• capture(java.security.Principal, com.aoapps.payments.Transaction)
• voidTransaction(java.security.Principal, com.aoapps.payments.Transaction)

capture

public CaptureResult capture(Principal principal,
 Transaction transaction)
                      throws SQLException

Captures the funds from a previous call to authorize.

Parameters:

principal - null is acceptable

Throws:

SQLException

See Also:

• authorize(java.security.Principal, com.aoapps.lang.security.acl.Group, com.aoapps.payments.TransactionRequest, com.aoapps.payments.CreditCard)

voidTransaction

public VoidResult voidTransaction(Principal principal,
 Transaction transaction)
                           throws SQLException

Voids a previous transaction. Updates the persistence mechanism. Updates the voidResult on the transaction. If the void was successful, updates the status of the transaction passed in. Transaction status must be AUTHORIZED, CAPTURED, or HOLD.

Throws:

SQLException - when unable to update the persistence layer

See Also:

• sale(java.security.Principal, com.aoapps.lang.security.acl.Group, com.aoapps.payments.TransactionRequest, com.aoapps.payments.CreditCard)
• authorize(java.security.Principal, com.aoapps.lang.security.acl.Group, com.aoapps.payments.TransactionRequest, com.aoapps.payments.CreditCard)
• capture(java.security.Principal, com.aoapps.payments.Transaction)

credit

public CreditResult credit(TransactionRequest transactionRequest,
 CreditCard creditCard)

Requests a credit.

canStoreCreditCards

public boolean canStoreCreditCards()
                            throws IOException

Queries the provider to see if they support the secure storage of credit cards.

Throws:

IOException - when unable to contact the bank

storeCreditCard

public void storeCreditCard(Principal principal,
 Group group,
 CreditCard creditCard)
                     throws IOException,
SQLException

Stores a credit card securely for later reuse. Sets the providerId, providerUniqueId, principalName, groupName, and persistenceUniqueId. Upon success, clears the cardNumber and expiration date.

Throws:

IOException - when unable to contact the bank

SQLException - when unable to store in the persistence layer

updateCreditCard

public void updateCreditCard(Principal principal,
 CreditCard creditCard)
                      throws IOException,
SQLException

Updates the credit card details, all except the card number and expiration. If card stored to secure storage, updates that storage. Any desired changes must have been made to creditCard object preceding this call.

Throws:

IOException - when unable to contact the bank

SQLException - when unable to store in the persistence layer

updateCreditCardNumberAndExpiration

public void updateCreditCardNumberAndExpiration(Principal principal,
 CreditCard creditCard,
 String cardNumber,
 byte expirationMonth,
 short expirationYear,
 String cardCode)
                                         throws IOException,
SQLException

Updates the credit card number, expiration, and (optionally) card code. If card stored to secure storage, updates that storage. Also updates creditCard directly.

Throws:

IOException - when unable to contact the bank

SQLException - when unable to store in the persistence layer

updateCreditCardExpiration

public void updateCreditCardExpiration(Principal principal,
 CreditCard creditCard,
 byte expirationMonth,
 short expirationYear)
                                throws IOException,
SQLException

Updates the credit card expiration. If card stored to secure storage, updates that storage. Also updates creditCard directly.

Throws:

IOException - when unable to contact the bank

SQLException

deleteCreditCard

public void deleteCreditCard(Principal principal,
 CreditCard creditCard)
                      throws IOException,
SQLException

Deletes the credit card information from the secure storage. Clears the providerUniqueId and persistenceUniqueId on the creditCard.

Throws:

IOException - when unable to contact the bank

SQLException - when unable to update the persistence layer

synchronizeStoredCards

public void synchronizeStoredCards(Principal principal,
 PrintWriter verboseOut,
 PrintWriter infoOut,
 PrintWriter warningOut,
 boolean dryRun)
                            throws IOException,
SQLException

Synchronizes any replacement masked card numbers or expiration dates from the provider back into the persistence mechanism.

This should be called periodically to keep the local representation of the card up-to-date with any new card information available from the payment provider, such as automatic card expiration updates.

Scheduling of the synchronization is beyond the scope of this project, but AO Cron may be fit for purpose.

Throws:

IOException

SQLException