org.broadleafcommerce.common.payment

Class PaymentTransactionType

java.lang.Object

org.broadleafcommerce.common.payment.PaymentTransactionType

All Implemented Interfaces:

Serializable, BroadleafEnumerationType

public class PaymentTransactionType
extends Object
implements Serializable, BroadleafEnumerationType

The PaymentTransactionType is used to represent the types of operations that could occur on the within the same payment. In the Broadleaf core framework, these types appear on the org.broadleafcommerce.core.payment.domain.PaymentTransaction.

Author:

Jerry Ocanas (jocanas), Phillip Verheyden (phillipuniverse)

See Also:

#AUTHORIZE}, #CAPTURE}, #AUTHORIZE_AND_CAPTURE}, #SETTLED}, #REFUND}, #VOID}, #REVERSE_AUTH}, #UNCONFIRMED}, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static PaymentTransactionType	AUTHORIZE Funds have been authorized for capture.
static PaymentTransactionType	AUTHORIZE_AND_CAPTURE Funds have been captured/authorized all at once.
static PaymentTransactionType	CAPTURE Funds have been charged/submitted/debited from the customer and payment is complete.
static PaymentTransactionType	REFUND Funds have been refunded/credited.
static PaymentTransactionType	REVERSE_AUTH The reverse of AUTHORIZE.
static PaymentTransactionType	SETTLED Can ONLY occur after a payment has been CAPTUREd.
static PaymentTransactionType	UNCONFIRMED This occurs for Payment Types like PayPal Express Checkout where a transaction must be confirmed at a later stage.
static PaymentTransactionType	VOID Void can happen after a CAPTURE but before it has been SETTLED.

Constructor Summary

Constructors

Constructor and Description
PaymentTransactionType()
PaymentTransactionType(String type, String friendlyType)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getFriendlyType()
static PaymentTransactionType	getInstance(String type)
String	getType()
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

AUTHORIZE

public static final PaymentTransactionType AUTHORIZE

Funds have been authorized for capture. This might appear as a 'pending' transaction on a customer's credit card statement

CAPTURE

public static final PaymentTransactionType CAPTURE

Funds have been charged/submitted/debited from the customer and payment is complete. Can ONLY occur after an amount has ben AUTHORIZEd.

AUTHORIZE_AND_CAPTURE

public static final PaymentTransactionType AUTHORIZE_AND_CAPTURE

Funds have been captured/authorized all at once. While this might be the simplest to implement from an order management perspective, the recommended approach is to AUTHORIZE and then CAPTURE in separate transactions and at separate times. For instance, an AUTHORIZE would happen once the Order has completed checkout but then a CAPTURE would happen once the Order has shipped.

NOTE: Many Gateways like to refer to this as also a SALE transaction.

This should be treated the exact same as a CAPTURE.

SETTLED

public static final PaymentTransactionType SETTLED

Can ONLY occur after a payment has been CAPTUREd. This represents a payment that has been balanced by the payment provider. This represents more finality than a CAPTURE. Some payment providers might not explicitly expose the details of settled transactions which are usually done in batches at the end of the day.

REFUND

public static final PaymentTransactionType REFUND

Funds have been refunded/credited. This can ONLY occur after funds have been CAPTUREd or SETTLED. This should only be used when money goes back to a customer.

VOID

public static final PaymentTransactionType VOID

Void can happen after a CAPTURE but before it has been SETTLED. Payment transactions are usually settled in batches at the end of the day. This basically performs the same action as a REFUND, although the transaction might not hit the customer's card.

REVERSE_AUTH

public static final PaymentTransactionType REVERSE_AUTH

The reverse of AUTHORIZE. This can ONLY occur AFTER funds have been AUTHORIZEd but BEFORE funds have been CAPTUREd.

UNCONFIRMED

public static final PaymentTransactionType UNCONFIRMED

This occurs for Payment Types like PayPal Express Checkout where a transaction must be confirmed at a later stage. A transaction is confirmed if the gateway has actually communicated something to hit against the user's card. There might be instances where payments have not been confirmed at the moment that those payments have actually been added to the order. For instance, there might be a scenario where it is desired to show a 'confirmation' page to the user before actually hitting 'submit' and completing the checkout workflow that actually takes funds away from the user account (this is also the desired case with gift cards and account credits). When the user adds all of the payments to their order, all of those payments may not have been confirmed by the gateway but they should be on checkout.

Unconfirmed transactions are confirmed in the checkout workflow via the ValidateAndConfirmPaymentActivity.

Constructor Detail

PaymentTransactionType

public PaymentTransactionType()

PaymentTransactionType

public PaymentTransactionType(String type,
                      String friendlyType)

Method Detail

getInstance

public static PaymentTransactionType getInstance(String type)

getType

public String getType()

Specified by:

getType in interface BroadleafEnumerationType

getFriendlyType

public String getFriendlyType()

Specified by:

getFriendlyType in interface BroadleafEnumerationType

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object