Package org.broadleafcommerce.common.payment

Class PaymentType

java.lang.Object

org.broadleafcommerce.common.payment.PaymentType

All Implemented Interfaces:

Serializable, BroadleafEnumerationType

public class PaymentType
extends Object
implements Serializable, BroadleafEnumerationType

This represents types of payments that can be applied to an order. There might be multiple order payments with the same type on an order if the customer can pay with multiple cards (like 2 credit cards or 3 gift cards).

Author:

Phillip Verheyden (phillipuniverse)

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final PaymentType	APPLE_PAY
static final PaymentType	BANK_ACCOUNT
static final PaymentType	CHECK
static final PaymentType	COD
static final PaymentType	CREDIT_CARD
static final PaymentType	CUSTOMER_CREDIT
static final PaymentType	CUSTOMER_PAYMENT
static final PaymentType	ELECTRONIC_CHECK
static final PaymentType	GIFT_CARD
static final PaymentType	GOOGLE_PAY
static final PaymentType	MONEY_ORDER
static final PaymentType	PURCHASE_ORDER
static final PaymentType	THIRD_PARTY_ACCOUNT	Intended for modules like PayPal Express Checkout
static final PaymentType	WIRE

Constructor Summary

Constructors

Constructor	Description
PaymentType()
PaymentType(String type, String friendlyType)
PaymentType(String type, String friendlyType, boolean isFinalPayment)
PaymentType(String type, String friendlyType, boolean isFinalPayment, boolean isCreditCardType)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getFriendlyType()
static PaymentType	getInstance(String type)
boolean	getIsFinalPayment()
String	getType()
int	hashCode()
boolean	isCreditCardType()
protected void	setType(String type)

Methods inherited from class java.lang.Object

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

Field Details

GIFT_CARD

public static final PaymentType GIFT_CARD

CREDIT_CARD

public static final PaymentType CREDIT_CARD

BANK_ACCOUNT

public static final PaymentType BANK_ACCOUNT

CHECK

public static final PaymentType CHECK

ELECTRONIC_CHECK

public static final PaymentType ELECTRONIC_CHECK

WIRE

public static final PaymentType WIRE

MONEY_ORDER

public static final PaymentType MONEY_ORDER

CUSTOMER_CREDIT

public static final PaymentType CUSTOMER_CREDIT

COD

public static final PaymentType COD

CUSTOMER_PAYMENT

public static final PaymentType CUSTOMER_PAYMENT

PURCHASE_ORDER

public static final PaymentType PURCHASE_ORDER

APPLE_PAY

public static final PaymentType APPLE_PAY

GOOGLE_PAY

public static final PaymentType GOOGLE_PAY

THIRD_PARTY_ACCOUNT

public static final PaymentType THIRD_PARTY_ACCOUNT

Intended for modules like PayPal Express Checkout

It is important to note that in this system an `UNCONFIRMED` `THIRD_PARTY_ACCOUNT` has a specific use case. The Order Payment amount can be variable. That means, when you confirm that `UNCONFIRMED` transaction, you can pass in a different amount than what was sent as the initial transaction amount. see (AdjustOrderPaymentsActivity)

Note that not all third party gateways support this feature described above. Make sure to the gateway does before assigning this type to your Order Payment.

Constructor Details

PaymentType

public PaymentType()

PaymentType

public PaymentType(String type,
 String friendlyType)

PaymentType

public PaymentType(String type,
 String friendlyType,
 boolean isFinalPayment)

PaymentType

public PaymentType(String type,
 String friendlyType,
 boolean isFinalPayment,
 boolean isCreditCardType)

Method Details

getInstance

public static PaymentType getInstance(String type)

getIsFinalPayment

public boolean getIsFinalPayment()

isCreditCardType

public boolean isCreditCardType()

getType

public String getType()

Specified by:

getType in interface BroadleafEnumerationType

setType

protected void setType(String type)

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