Package org.apache.ofbiz.accounting.payment

Class PaymentGatewayServices

java.lang.Object

org.apache.ofbiz.accounting.payment.PaymentGatewayServices

public class PaymentGatewayServices
extends Object

PaymentGatewayServices

Constructor Summary

Constructors

Constructor	Description
PaymentGatewayServices()

Method Summary

Modifier and Type	Method	Description
static Map<String,Object>	alwaysApproveProcessor(DispatchContext dctx, Map<String,? extends Object> context)	Always approve processor.
static Map<String,Object>	alwaysApproveWithCapture(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	alwaysBadCardNumberProcessor(DispatchContext dctx, Map<String,? extends Object> context)	Always bad card number processor
static Map<String,Object>	alwaysBadExpireProcessor(DispatchContext dctx, Map<String,? extends Object> context)	Always fail/bad expire date processor
static Map<String,Object>	alwaysDeclineProcessor(DispatchContext dctx, Map<String,? extends Object> context)	Always decline processor
static Map<String,Object>	alwaysFailProcessor(DispatchContext dctx, Map<String,? extends Object> context)	Always fail (error) processor
static Map<String,Object>	alwaysNsfProcessor(DispatchContext dctx, Map<String,? extends Object> context)	Always NSF (not sufficient funds) processor
static Map<String,Object>	authOrderPaymentPreference(DispatchContext dctx, Map<String,? extends Object> context)	Authorizes a single order preference with an option to specify an amount.
static Map<String,Object>	authOrderPayments(DispatchContext dctx, Map<String,? extends Object> context)	Processes payments through service calls to the defined processing service for the ProductStore/PaymentMethodType
static Map<String,Object>	badExpireEvenProcessor(DispatchContext dctx, Map<String,? extends Object> context)	Fail/bad expire date when year is even processor
static Map<String,Object>	captureBillingAccountPayments(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	captureOrderPayments(DispatchContext dctx, Map<String,? extends Object> context)	Captures payments through service calls to the defined processing service for the ProductStore/PaymentMethodType
static Map<String,Object>	capturePaymentsByInvoice(DispatchContext dctx, Map<String,? extends Object> context)	Captures payments through service calls to the defined processing service for the ProductStore/PaymentMethodType
static boolean	checkAuthValidity(GenericValue orderPaymentPreference, String paymentConfig)
static Timestamp	getAuthTime(GenericValue orderPaymentPreference)
static GenericValue	getAuthTransaction(GenericValue orderPaymentPreference)	Gets the chronologically latest PaymentGatewayResponse from an OrderPaymentPreference which is either a PRDS_PAY_AUTH or PRDS_PAY_REAUTH.
static List<GenericValue>	getAuthTransactions(GenericValue orderPaymentPreference)	Gets a chronologically ordered list of PaymentGatewayResponses from an OrderPaymentPreference which is either a PRDS_PAY_AUTH or PRDS_PAY_REAUTH.
static GenericValue	getCaptureTransaction(GenericValue orderPaymentPreference)
static Map<String,Object>	processAuthResult(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	processCaptureResult(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	processCaptureSplitPayment(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	processCreditResult(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	processManualCcAuth(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	processManualCcTx(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	processRefundResult(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	processReleaseResult(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	refundOrderPaymentPreference(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	refundPayment(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	releaseOrderPaymentPreference(DispatchContext dctx, Map<String,? extends Object> context)	Releases authorization for a single OrderPaymentPreference through service calls to the defined processing service for the ProductStore/PaymentMethodType
static Map<String,Object>	releaseOrderPayments(DispatchContext dctx, Map<String,? extends Object> context)	Releases authorizations through service calls to the defined processing service for the ProductStore/PaymentMethodType
static Map<String,Object>	retryFailedAuthNsfs(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	retryFailedAuths(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	retryFailedOrderAuth(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	savePaymentGatewayResponse(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	savePaymentGatewayResponseAndMessages(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	storePaymentErrorMessage(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	testCapture(DispatchContext dctx, Map<String,? extends Object> context)	Test capture service (returns true)
static Map<String,Object>	testCaptureWithReAuth(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	testCCProcessorCaptureAlwaysDecline(DispatchContext dctx, Map<String,? extends Object> context)	Always decline processor
static Map<String,Object>	testProcessor(DispatchContext dctx, Map<String,? extends Object> context)	Simple test processor; declines all orders < 100.00; approves all orders >= 100.00
static Map<String,Object>	testProcessorWithCapture(DispatchContext dctx, Map<String,? extends Object> context)	Simple test processor; declines all orders < 100.00; approves all orders > 100.00
static Map<String,Object>	testRandomAuthorize(DispatchContext dctx, Map<String,? extends Object> context)	Test authorize - does random declines
static Map<String,Object>	testRefund(DispatchContext dctx, Map<String,? extends Object> context)	Test refund service (returns true)
static Map<String,Object>	testRefundFailure(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	testRelease(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	verifyCreditCard(DispatchContext dctx, Map<String,? extends Object> context)

Methods inherited from class java.lang.Object

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

Constructor Details

PaymentGatewayServices

public PaymentGatewayServices()

Method Details

authOrderPaymentPreference

public static Map<String,Object> authOrderPaymentPreference(DispatchContext dctx,
 Map<String,? extends Object> context)

Authorizes a single order preference with an option to specify an amount. The result map has the Booleans "errors" and "finished" which notify the user if there were any errors and if the authorization was finished. There is also a List "messages" for the authorization response messages and a BigDecimal, "processAmount" as the amount processed. TODO: it might be nice to return the paymentGatewayResponseId

authOrderPayments

public static Map<String,Object> authOrderPayments(DispatchContext dctx,
 Map<String,? extends Object> context)

Processes payments through service calls to the defined processing service for the ProductStore/PaymentMethodType

Returns:

APPROVED|FAILED|ERROR for complete processing of ALL payment methods.

releaseOrderPayments

public static Map<String,Object> releaseOrderPayments(DispatchContext dctx,
 Map<String,? extends Object> context)

Releases authorizations through service calls to the defined processing service for the ProductStore/PaymentMethodType

Returns:

COMPLETE|FAILED|ERROR for complete processing of ALL payments.

processCreditResult

public static Map<String,Object> processCreditResult(DispatchContext dctx,
 Map<String,? extends Object> context)

releaseOrderPaymentPreference

public static Map<String,Object> releaseOrderPaymentPreference(DispatchContext dctx,
 Map<String,? extends Object> context)

Releases authorization for a single OrderPaymentPreference through service calls to the defined processing service for the ProductStore/PaymentMethodType

Returns:

SUCCESS|FAILED|ERROR for complete processing of payment.

processReleaseResult

public static Map<String,Object> processReleaseResult(DispatchContext dctx,
 Map<String,? extends Object> context)

capturePaymentsByInvoice

public static Map<String,Object> capturePaymentsByInvoice(DispatchContext dctx,
 Map<String,? extends Object> context)

Captures payments through service calls to the defined processing service for the ProductStore/PaymentMethodType

Returns:

COMPLETE|FAILED|ERROR for complete processing of ALL payment methods.

captureOrderPayments

public static Map<String,Object> captureOrderPayments(DispatchContext dctx,
 Map<String,? extends Object> context)

Captures payments through service calls to the defined processing service for the ProductStore/PaymentMethodType

Returns:

COMPLETE|FAILED|ERROR for complete processing of ALL payment methods.

processCaptureSplitPayment

public static Map<String,Object> processCaptureSplitPayment(DispatchContext dctx,
 Map<String,? extends Object> context)

captureBillingAccountPayments

public static Map<String,Object> captureBillingAccountPayments(DispatchContext dctx,
 Map<String,? extends Object> context)

storePaymentErrorMessage

public static Map<String,Object> storePaymentErrorMessage(DispatchContext dctx,
 Map<String,? extends Object> context)

processAuthResult

public static Map<String,Object> processAuthResult(DispatchContext dctx,
 Map<String,? extends Object> context)

processCaptureResult

public static Map<String,Object> processCaptureResult(DispatchContext dctx,
 Map<String,? extends Object> context)

refundOrderPaymentPreference

public static Map<String,Object> refundOrderPaymentPreference(DispatchContext dctx,
 Map<String,? extends Object> context)

refundPayment

public static Map<String,Object> refundPayment(DispatchContext dctx,
 Map<String,? extends Object> context)

processRefundResult

public static Map<String,Object> processRefundResult(DispatchContext dctx,
 Map<String,? extends Object> context)

retryFailedOrderAuth

public static Map<String,Object> retryFailedOrderAuth(DispatchContext dctx,
 Map<String,? extends Object> context)

retryFailedAuths

public static Map<String,Object> retryFailedAuths(DispatchContext dctx,
 Map<String,? extends Object> context)

retryFailedAuthNsfs

public static Map<String,Object> retryFailedAuthNsfs(DispatchContext dctx,
 Map<String,? extends Object> context)

getCaptureTransaction

public static GenericValue getCaptureTransaction(GenericValue orderPaymentPreference)

getAuthTransaction

public static GenericValue getAuthTransaction(GenericValue orderPaymentPreference)

Gets the chronologically latest PaymentGatewayResponse from an OrderPaymentPreference which is either a PRDS_PAY_AUTH or PRDS_PAY_REAUTH. Used for capturing.

Parameters:

orderPaymentPreference - GenericValue object of the order payment preference

Returns:

return the first authorization of the order payment preference

getAuthTransactions

public static List<GenericValue> getAuthTransactions(GenericValue orderPaymentPreference)

Gets a chronologically ordered list of PaymentGatewayResponses from an OrderPaymentPreference which is either a PRDS_PAY_AUTH or PRDS_PAY_REAUTH.

Parameters:

orderPaymentPreference - GenericValue object of the order payment preference

Returns:

return the authorizations of the order payment preference

getAuthTime

public static Timestamp getAuthTime(GenericValue orderPaymentPreference)

checkAuthValidity

public static boolean checkAuthValidity(GenericValue orderPaymentPreference,
 String paymentConfig)

savePaymentGatewayResponse

public static Map<String,Object> savePaymentGatewayResponse(DispatchContext dctx,
 Map<String,? extends Object> context)

savePaymentGatewayResponseAndMessages

public static Map<String,Object> savePaymentGatewayResponseAndMessages(DispatchContext dctx,
 Map<String,? extends Object> context)

processManualCcAuth

public static Map<String,Object> processManualCcAuth(DispatchContext dctx,
 Map<String,? extends Object> context)

processManualCcTx

public static Map<String,Object> processManualCcTx(DispatchContext dctx,
 Map<String,? extends Object> context)

verifyCreditCard

public static Map<String,Object> verifyCreditCard(DispatchContext dctx,
 Map<String,? extends Object> context)

testProcessor

public static Map<String,Object> testProcessor(DispatchContext dctx,
 Map<String,? extends Object> context)

Simple test processor; declines all orders < 100.00; approves all orders >= 100.00

testProcessorWithCapture

public static Map<String,Object> testProcessorWithCapture(DispatchContext dctx,
 Map<String,? extends Object> context)

Simple test processor; declines all orders < 100.00; approves all orders > 100.00

testRandomAuthorize

public static Map<String,Object> testRandomAuthorize(DispatchContext dctx,
 Map<String,? extends Object> context)

Test authorize - does random declines

alwaysApproveProcessor

public static Map<String,Object> alwaysApproveProcessor(DispatchContext dctx,
 Map<String,? extends Object> context)

Always approve processor.

alwaysApproveWithCapture

public static Map<String,Object> alwaysApproveWithCapture(DispatchContext dctx,
 Map<String,? extends Object> context)

alwaysDeclineProcessor

public static Map<String,Object> alwaysDeclineProcessor(DispatchContext dctx,
 Map<String,? extends Object> context)

Always decline processor

alwaysNsfProcessor

public static Map<String,Object> alwaysNsfProcessor(DispatchContext dctx,
 Map<String,? extends Object> context)

Always NSF (not sufficient funds) processor

alwaysBadExpireProcessor

public static Map<String,Object> alwaysBadExpireProcessor(DispatchContext dctx,
 Map<String,? extends Object> context)

Always fail/bad expire date processor

badExpireEvenProcessor

public static Map<String,Object> badExpireEvenProcessor(DispatchContext dctx,
 Map<String,? extends Object> context)

Fail/bad expire date when year is even processor

alwaysBadCardNumberProcessor

public static Map<String,Object> alwaysBadCardNumberProcessor(DispatchContext dctx,
 Map<String,? extends Object> context)

Always bad card number processor

alwaysFailProcessor

public static Map<String,Object> alwaysFailProcessor(DispatchContext dctx,
 Map<String,? extends Object> context)

Always fail (error) processor

testRelease

public static Map<String,Object> testRelease(DispatchContext dctx,
 Map<String,? extends Object> context)

testCapture

public static Map<String,Object> testCapture(DispatchContext dctx,
 Map<String,? extends Object> context)

Test capture service (returns true)

testCCProcessorCaptureAlwaysDecline

public static Map<String,Object> testCCProcessorCaptureAlwaysDecline(DispatchContext dctx,
 Map<String,? extends Object> context)

Always decline processor

testCaptureWithReAuth

public static Map<String,Object> testCaptureWithReAuth(DispatchContext dctx,
 Map<String,? extends Object> context)

testRefund

public static Map<String,Object> testRefund(DispatchContext dctx,
 Map<String,? extends Object> context)

Test refund service (returns true)

testRefundFailure

public static Map<String,Object> testRefundFailure(DispatchContext dctx,
 Map<String,? extends Object> context)