org.broadleafcommerce.common.payment

Class PaymentGatewayRequestType

java.lang.Object

org.broadleafcommerce.common.payment.PaymentGatewayRequestType

All Implemented Interfaces:

Serializable, BroadleafEnumerationType

public class PaymentGatewayRequestType
extends Object
implements Serializable, BroadleafEnumerationType

Gateways/processors support a vast array of different features, and in some cases a single API will perform several different functions based on the state of the request. To fully support this and maintain a consistent API, this extensible enumeration of request types are provided to aid the gateway's implementations determination of the correct request to construct (in the case that the current implementation supports it).

For example: 1. Certain gateways support the idea of a "Transparent Redirect" request. Within that set, only certain ones support the idea of a transparent redirect tokenization only request. In order to utilize the same PaymentGatewayTransparentRedirectService, a particular request type, (e.g. CREATE_CUSTOMER_PAYMENT_TR can be put on the PaymentRequestDTO to distinguish which request to construct. 2. Certain gateways support the idea of a "Detached Credit" also referred to as a "blind credit" In some cases, the gateways implementation utilizes the same "refund" api as a normal credit. DETACHED_CREDIT_REFUND can be passed to an implementation's PaymentGatewayTransactionService.refund(org.broadleafcommerce.common.payment.dto.PaymentRequestDTO) method to distinguish what type of refund to construct. 3. Some gateway implementations allow you to pass a manual authorization code received from the bank. For example, a customer service representative can take orders over the phone and call the bank directly to get an authorization code for the customer's card. In this scenario, if your gateway supports this, MANUAL_AUTHORIZATION can be passed into an implementation's PaymentGatewayTransactionService.authorize(org.broadleafcommerce.common.payment.dto.PaymentRequestDTO) method to distinguish what type of authorization to construct.

Author:

Elbert Bautista (elbertbautista)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static PaymentGatewayRequestType	CREATE_CUSTOMER_PAYMENT_TR
static PaymentGatewayRequestType	DETACHED_CREDIT_REFUND
static PaymentGatewayRequestType	MANUAL_AUTHORIZATION
static PaymentGatewayRequestType	UPDATE_CUSTOMER_PAYMENT_TR

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getFriendlyType()
static PaymentGatewayRequestType	getInstance(String type)
String	getType()
static Map<String,PaymentGatewayRequestType>	getTypes()
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

CREATE_CUSTOMER_PAYMENT_TR

public static final PaymentGatewayRequestType CREATE_CUSTOMER_PAYMENT_TR

UPDATE_CUSTOMER_PAYMENT_TR

public static final PaymentGatewayRequestType UPDATE_CUSTOMER_PAYMENT_TR

DETACHED_CREDIT_REFUND

public static final PaymentGatewayRequestType DETACHED_CREDIT_REFUND

MANUAL_AUTHORIZATION

public static final PaymentGatewayRequestType MANUAL_AUTHORIZATION

Constructor Detail

PaymentGatewayRequestType

public PaymentGatewayRequestType()

PaymentGatewayRequestType

public PaymentGatewayRequestType(String type,
                         String friendlyType)

Method Detail

getInstance

public static PaymentGatewayRequestType getInstance(String type)

getTypes

public static Map<String,PaymentGatewayRequestType> getTypes()

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