A B C D E F G H I L M N O P Q R S T U V W

A

AbstractExternalPaymentGatewayCall<T,R> - Class in com.broadleafcommerce.paymentgateway.service

All payment gateway classes that intend to make an external call, either manually from an HTTP Post or through an SDK which makes its own external call, should extend this class.

AbstractExternalPaymentGatewayCall() - Constructor for class com.broadleafcommerce.paymentgateway.service.AbstractExternalPaymentGatewayCall

accountNumber(String) - Method in class com.broadleafcommerce.paymentgateway.domain.CustomerCredit

AccountNumberMaskUtil - Class in com.broadleafcommerce.paymentgateway.util

AccountNumberMaskUtil(List<UnmaskRange>, char) - Constructor for class com.broadleafcommerce.paymentgateway.util.AccountNumberMaskUtil

addCustomerAttributeToCurrentCustomer(String, String) - Method in interface com.broadleafcommerce.paymentgateway.service.CurrentCustomerPaymentRequestService

adds a concept of an "customer attribute" to the current customer in the system

addCustomerAttributeToCustomer(Long, String, String) - Method in interface com.broadleafcommerce.paymentgateway.service.CurrentCustomerPaymentRequestService

adds a concept of a "customer attribute" to a customer in the system based on ID.

additionalField(String, Object) - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

additionalField(String, Object) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

additionalFields(Map<String, Object>) - Method in class com.broadleafcommerce.paymentgateway.domain.Address

additionalFields(String, Object) - Method in class com.broadleafcommerce.paymentgateway.domain.Address

additionalFields(String, Object) - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

additionalFields(String, Object) - Method in class com.broadleafcommerce.paymentgateway.domain.CustomerCredit

additionalFields(Map<String, Object>) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

additionalFields(String, Object) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

additionalFields(String, Object) - Method in class com.broadleafcommerce.paymentgateway.domain.GiftCard

additionalFields - Variable in class com.broadleafcommerce.paymentgateway.domain.Subscription

Any extra properties needed to define the subscription

additionalFields(String, Object) - Method in class com.broadleafcommerce.paymentgateway.domain.Subscription

Address<T> - Class in com.broadleafcommerce.paymentgateway.domain

Address() - Constructor for class com.broadleafcommerce.paymentgateway.domain.Address

Address(T) - Constructor for class com.broadleafcommerce.paymentgateway.domain.Address

addressLine1(String) - Method in class com.broadleafcommerce.paymentgateway.domain.Address

addressLine2(String) - Method in class com.broadleafcommerce.paymentgateway.domain.Address

addressPopulated() - Method in class com.broadleafcommerce.paymentgateway.domain.Address

adjustmentsTotal(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

amount(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

amount(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

applyPaymentToOrder(PaymentResponse, PaymentGatewayConfiguration) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayCheckoutService

authorize(PaymentRequest) - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughTransactionService

authorize(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransactionService

Responsible for executing a DefaultTransactionTypes.AUTHORIZE transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.

authorizeAndCapture(PaymentRequest) - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughTransactionService

authorizeAndCapture(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransactionService

Responsible for executing a DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.

B

BEGINNINGTYPE - Static variable in class com.broadleafcommerce.paymentgateway.util.UnmaskRange

billTo() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

You should only call this once, as it will create a new bill to address if called more than once.

billTo() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

billToPopulated() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

buildPaymentResponse(PaymentRequest, PaymentGatewayType, TransactionType) - Method in class com.broadleafcommerce.paymentgateway.util.DefaultPaymentResponseUtil

buildPaymentResponse(PaymentRequest, PaymentGatewayType, TransactionType) - Method in interface com.broadleafcommerce.paymentgateway.util.PaymentResponseUtil

Builds and populates a PaymentResponse based on the provided PaymentRequest

C

cancelGatewaySubscription(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewaySubscriptionService

capture(PaymentRequest) - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughTransactionService

capture(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransactionService

Responsible for executing a DefaultTransactionTypes.CAPTURE transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.

cardHolderName(String) - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

cardNumber(String) - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

cardNumber(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GiftCard

cardType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

category(String) - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

checkService(ServiceStatusDetectable) - Method in class com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceMonitor

checkServiceAOP(ProceedingJoinPoint) - Method in class com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceMonitor

city(String) - Method in class com.broadleafcommerce.paymentgateway.domain.Address

clearStatus() - Method in class com.broadleafcommerce.paymentgateway.service.AbstractExternalPaymentGatewayCall

clearStatus() - Method in interface com.broadleafcommerce.paymentgateway.service.FailureCountExposable

com.broadleafcommerce.paymentgateway.constants - package com.broadleafcommerce.paymentgateway.constants

com.broadleafcommerce.paymentgateway.domain - package com.broadleafcommerce.paymentgateway.domain

com.broadleafcommerce.paymentgateway.domain.enums - package com.broadleafcommerce.paymentgateway.domain.enums

com.broadleafcommerce.paymentgateway.service - package com.broadleafcommerce.paymentgateway.service

com.broadleafcommerce.paymentgateway.service.exception - package com.broadleafcommerce.paymentgateway.service.exception

com.broadleafcommerce.paymentgateway.service.passthrough - package com.broadleafcommerce.paymentgateway.service.passthrough

com.broadleafcommerce.paymentgateway.service.provider - package com.broadleafcommerce.paymentgateway.service.provider

com.broadleafcommerce.paymentgateway.service.webresponse.servlet - package com.broadleafcommerce.paymentgateway.service.webresponse.servlet

com.broadleafcommerce.paymentgateway.util - package com.broadleafcommerce.paymentgateway.util

com.broadleafcommerce.paymentgateway.util.autoconfigure - package com.broadleafcommerce.paymentgateway.util.autoconfigure

com.broadleafcommerce.paymentgateway.vendor.service.monitor - package com.broadleafcommerce.paymentgateway.vendor.service.monitor

com.broadleafcommerce.paymentgateway.vendor.service.monitor.handler - package com.broadleafcommerce.paymentgateway.vendor.service.monitor.handler

com.broadleafcommerce.paymentgateway.vendor.service.type - package com.broadleafcommerce.paymentgateway.vendor.service.type

communicateWithVendor(T) - Method in class com.broadleafcommerce.paymentgateway.service.AbstractExternalPaymentGatewayCall

companyName(String) - Method in class com.broadleafcommerce.paymentgateway.domain.Address

companyName(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

completeCheckoutOnCallback(boolean) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

completeCheckoutOnCallback(boolean) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

CompositeStatusHandler - Class in com.broadleafcommerce.paymentgateway.vendor.service.monitor.handler

CompositeStatusHandler(List<StatusHandler>) - Constructor for class com.broadleafcommerce.paymentgateway.vendor.service.monitor.handler.CompositeStatusHandler

confirmTransaction(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransactionConfirmationService

countryCode(String) - Method in class com.broadleafcommerce.paymentgateway.domain.Address

createAuthorizeAndCaptureForm(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransparentRedirectService

createAuthorizeForm(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransparentRedirectService

createCustomerPaymentFromResponseDTO(PaymentResponse, PaymentGatewayConfiguration) - Method in interface com.broadleafcommerce.paymentgateway.service.CustomerPaymentGatewayService

createCustomerPaymentTokenForm(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransparentRedirectService

createGatewayCreditCard(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayCreditCardService

createGatewayCustomer(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayCustomerService

createGatewaySubscription(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewaySubscriptionService

CreditCard<T> - Class in com.broadleafcommerce.paymentgateway.domain

CreditCard() - Constructor for class com.broadleafcommerce.paymentgateway.domain.CreditCard

CreditCard(T) - Constructor for class com.broadleafcommerce.paymentgateway.domain.CreditCard

creditCard() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

You should only call this once, as it will create a new credit card if called more than once.

creditCard() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

creditCardPopulated() - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

creditCardPopulated() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

CreditCardType - Enum in com.broadleafcommerce.paymentgateway.domain.enums

An enumeration of credit card types.

CreditCardTypeCheckUtil - Class in com.broadleafcommerce.paymentgateway.util

CreditCardTypeCheckUtil() - Constructor for class com.broadleafcommerce.paymentgateway.util.CreditCardTypeCheckUtil

CurrentCustomerPaymentRequestService - Interface in com.broadleafcommerce.paymentgateway.service

Simple interface for returning a PaymentRequest based on the current customer in the system (like something on threadlocal).

customer() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

You should only call this once, as it will create a new customer if called more than once.

customer(GatewayCustomer<PaymentResponse>) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

customer() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

CustomerCredit<T> - Class in com.broadleafcommerce.paymentgateway.domain

CustomerCredit() - Constructor for class com.broadleafcommerce.paymentgateway.domain.CustomerCredit

CustomerCredit(T) - Constructor for class com.broadleafcommerce.paymentgateway.domain.CustomerCredit

customerCredit() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

You should only call this once, as it will create a new gift card if called more than once.

customerCredit() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

customerId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

CustomerPaymentGatewayService - Interface in com.broadleafcommerce.paymentgateway.service

This is designed as a generic contract for allowing payment modules to tokenize payments and add it to a customer profile represented in Broadleaf while still staying decoupled from any of the Broadleaf core framework concepts.

customerPopulated() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

customerPopulated() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

cvv(String) - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

D

dateRecorded(Instant) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

declineType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

DefaultGatewayFeatureType - Enum in com.broadleafcommerce.paymentgateway.domain.enums

Defines common features that gateways implement.

defaultHandler - Variable in class com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceMonitor

DefaultPassthroughConfiguration - Class in com.broadleafcommerce.paymentgateway.service.passthrough

DefaultPassthroughConfiguration() - Constructor for class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughConfiguration

DefaultPassthroughPaymentValidator - Class in com.broadleafcommerce.paymentgateway.service.passthrough

DefaultPassthroughPaymentValidator() - Constructor for class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughPaymentValidator

DefaultPassthroughTransactionService - Class in com.broadleafcommerce.paymentgateway.service.passthrough

DefaultPassthroughTransactionService() - Constructor for class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughTransactionService

DefaultPaymentGatewayClientTokenServiceProvider - Class in com.broadleafcommerce.paymentgateway.service.provider

DefaultPaymentGatewayClientTokenServiceProvider(List<PaymentGatewayClientTokenService>) - Constructor for class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayClientTokenServiceProvider

DefaultPaymentGatewayConfigurationProvider - Class in com.broadleafcommerce.paymentgateway.service.provider

DefaultPaymentGatewayConfigurationProvider(List<PaymentGatewayConfiguration>) - Constructor for class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayConfigurationProvider

DefaultPaymentGatewayCreditCardServiceProvider - Class in com.broadleafcommerce.paymentgateway.service.provider

DefaultPaymentGatewayCreditCardServiceProvider(List<PaymentGatewayCreditCardService>) - Constructor for class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayCreditCardServiceProvider

DefaultPaymentGatewayCustomerServiceProvider - Class in com.broadleafcommerce.paymentgateway.service.provider

DefaultPaymentGatewayCustomerServiceProvider(List<PaymentGatewayCustomerService>) - Constructor for class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayCustomerServiceProvider

DefaultPaymentGatewayFraudServiceProvider - Class in com.broadleafcommerce.paymentgateway.service.provider

DefaultPaymentGatewayFraudServiceProvider(List<PaymentGatewayFraudService>) - Constructor for class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayFraudServiceProvider

DefaultPaymentGatewayHostedServiceProvider - Class in com.broadleafcommerce.paymentgateway.service.provider

DefaultPaymentGatewayHostedServiceProvider(List<PaymentGatewayHostedService>) - Constructor for class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayHostedServiceProvider

DefaultPaymentGatewayPaymentValidationProvider - Class in com.broadleafcommerce.paymentgateway.service.provider

DefaultPaymentGatewayPaymentValidationProvider(List<PaymentGatewayPaymentValidator>) - Constructor for class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayPaymentValidationProvider

DefaultPaymentGatewayReportingServiceProvider - Class in com.broadleafcommerce.paymentgateway.service.provider

DefaultPaymentGatewayReportingServiceProvider(List<PaymentGatewayReportingService>) - Constructor for class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayReportingServiceProvider

DefaultPaymentGatewayRollbackServiceProvider - Class in com.broadleafcommerce.paymentgateway.service.provider

DefaultPaymentGatewayRollbackServiceProvider(List<PaymentGatewayRollbackService>) - Constructor for class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayRollbackServiceProvider

DefaultPaymentGatewaySubscriptionServiceProvider - Class in com.broadleafcommerce.paymentgateway.service.provider

DefaultPaymentGatewaySubscriptionServiceProvider(List<PaymentGatewaySubscriptionService>) - Constructor for class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewaySubscriptionServiceProvider

DefaultPaymentGatewayTransactionConfirmationServiceProvider - Class in com.broadleafcommerce.paymentgateway.service.provider

DefaultPaymentGatewayTransactionConfirmationServiceProvider(List<PaymentGatewayTransactionConfirmationService>) - Constructor for class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayTransactionConfirmationServiceProvider

DefaultPaymentGatewayTransactionServiceProvider - Class in com.broadleafcommerce.paymentgateway.service.provider

DefaultPaymentGatewayTransactionServiceProvider(List<PaymentGatewayTransactionService>) - Constructor for class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayTransactionServiceProvider

DefaultPaymentGatewayTransparentRedirectServiceProvider - Class in com.broadleafcommerce.paymentgateway.service.provider

DefaultPaymentGatewayTransparentRedirectServiceProvider(List<PaymentGatewayTransparentRedirectService>) - Constructor for class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayTransparentRedirectServiceProvider

DefaultPaymentGatewayTypes - Enum in com.broadleafcommerce.paymentgateway.domain.enums

The default set of payment gateway types.

DefaultPaymentGatewayWebResponsePrintService - Class in com.broadleafcommerce.paymentgateway.service.webresponse.servlet

This default implementation produces the Request Attributes and Request Paremeters in JSON notation.

DefaultPaymentGatewayWebResponsePrintService() - Constructor for class com.broadleafcommerce.paymentgateway.service.webresponse.servlet.DefaultPaymentGatewayWebResponsePrintService

DefaultPaymentGatewayWebResponseServiceProvider - Class in com.broadleafcommerce.paymentgateway.service.provider

DefaultPaymentGatewayWebResponseServiceProvider(List<PaymentGatewayWebResponseService>) - Constructor for class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayWebResponseServiceProvider

DefaultPaymentLogEventTypes - Enum in com.broadleafcommerce.paymentgateway.domain.enums

The default set of log event types for payment interactions.

DefaultPaymentResponseUtil - Class in com.broadleafcommerce.paymentgateway.util

DefaultPaymentResponseUtil(TypeFactory) - Constructor for class com.broadleafcommerce.paymentgateway.util.DefaultPaymentResponseUtil

DefaultPaymentTypes - Enum in com.broadleafcommerce.paymentgateway.domain.enums

This represents types of payments that can be applied to a cart.

DefaultTransactionFailureTypes - Enum in com.broadleafcommerce.paymentgateway.domain.enums

The default set of transactionFailureTypes that we expect to encounter with payment gateway interactions

DefaultTransactionTypes - Enum in com.broadleafcommerce.paymentgateway.domain.enums

The TransactionType is used to represent the types of operations/transactions that could occur against a single payment.

deleteCustomerPaymentFromResponseDTO(PaymentResponse, PaymentGatewayConfiguration) - Method in interface com.broadleafcommerce.paymentgateway.service.CustomerPaymentGatewayService

deleteGatewayCreditCard(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayCreditCardService

deleteGatewayCustomer(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayCustomerService

description(String) - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

done() - Method in class com.broadleafcommerce.paymentgateway.domain.Address

done() - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

done() - Method in class com.broadleafcommerce.paymentgateway.domain.CustomerCredit

done() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

done() - Method in class com.broadleafcommerce.paymentgateway.domain.GiftCard

done() - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

done() - Method in class com.broadleafcommerce.paymentgateway.domain.Subscription

E

email(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

emailAddress(String) - Method in class com.broadleafcommerce.paymentgateway.domain.Address

ENDTYPE - Static variable in class com.broadleafcommerce.paymentgateway.util.UnmaskRange

expDate(String) - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

expMonth(String) - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

expYear(String) - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

F

failureCount - Variable in class com.broadleafcommerce.paymentgateway.service.AbstractExternalPaymentGatewayCall

FailureCountExposable - Interface in com.broadleafcommerce.paymentgateway.service

This interface is a lightweight replacement of gateway-specific classes extending AbstractExternalPaymentGatewayCall, and it helps expose some f the QoS inner methods, for testing purposes.

failureType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

fax(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

findDetailsByTransaction(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayReportingService

firstName(String) - Method in class com.broadleafcommerce.paymentgateway.domain.Address

firstName(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

frequency - Variable in class com.broadleafcommerce.paymentgateway.domain.Subscription

How often the customer will be charged

frequency(String) - Method in class com.broadleafcommerce.paymentgateway.domain.Subscription

fullName(String) - Method in class com.broadleafcommerce.paymentgateway.domain.Address

G

GatewayCustomer<T> - Class in com.broadleafcommerce.paymentgateway.domain

GatewayCustomer() - Constructor for class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

GatewayCustomer(T) - Constructor for class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

gatewayRequestType(PaymentGatewayRequestType) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

gatewayResponseCode(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

generateClientToken(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayClientTokenService

getAccountNumber() - Method in class com.broadleafcommerce.paymentgateway.domain.CustomerCredit

getAdditionalField(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

getAdditionalFields() - Method in class com.broadleafcommerce.paymentgateway.domain.Address

getAdditionalFields() - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

getAdditionalFields() - Method in class com.broadleafcommerce.paymentgateway.domain.CustomerCredit

getAdditionalFields() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

getAdditionalFields() - Method in class com.broadleafcommerce.paymentgateway.domain.GiftCard

getAdditionalFields() - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

getAdditionalFields() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

Any extra properties needed to define the requested transaction

getAdditionalFields() - Method in class com.broadleafcommerce.paymentgateway.domain.Subscription

Any extra properties needed to define the subscription

getAddressLine1() - Method in class com.broadleafcommerce.paymentgateway.domain.Address

getAddressLine2() - Method in class com.broadleafcommerce.paymentgateway.domain.Address

getAdjustmentsTotal() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

The order's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.

getAmount() - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

getAmount() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

getBillTo() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

The billing address associated with this transaction

getBillTo() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

The billing address associated with this transaction

getCardHolderName() - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

getCardNumber() - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

getCardNumber() - Method in class com.broadleafcommerce.paymentgateway.domain.GiftCard

getCardType() - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

getCategory() - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

getCheckoutTransactionType() - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughConfiguration

Set the TransactionType that should be performed during checkout.

getCheckoutTransactionType() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

Returns the TransactionType that should be performed during checkout.

getCity() - Method in class com.broadleafcommerce.paymentgateway.domain.Address

getClientTokenService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayClientTokenServiceProvider

getClientTokenService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayClientTokenServiceProvider

Returns the first PaymentGatewayClientTokenService that matches the given PaymentGatewayType.

getClientTokenServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayClientTokenServiceProvider

getCompanyName() - Method in class com.broadleafcommerce.paymentgateway.domain.Address

getCompanyName() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

getConfiguration(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayConfigurationProvider

getConfiguration(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayConfigurationProvider

Returns the first PaymentGatewayConfiguration that matches the given PaymentGatewayType.

getCountryCode() - Method in class com.broadleafcommerce.paymentgateway.domain.Address

getCreateCustomerPaymentTokenCancelURLFieldKey(PaymentResponse) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransparentRedirectService

Return the PaymentResponse.getResponseMap() key that corresponds to creating the customer token cancel url

getCreateCustomerPaymentTokenReturnURLFieldKey(PaymentResponse) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransparentRedirectService

Return the PaymentResponse.getResponseMap() key that corresponds to creating the customer token return url

getCreditCard() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

For sale/authorize transactions, this will be the Credit Card object that was charged.

getCreditCard() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

for sale/authorize transactions, this will be the Credit Card object that was charged.

getCreditCardService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayCreditCardServiceProvider

getCreditCardService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayCreditCardServiceProvider

Returns the first PaymentGatewayCreditCardService that matches the given PaymentGatewayType.

getCreditCardServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayCreditCardServiceProvider

getCreditCardType(String) - Static method in class com.broadleafcommerce.paymentgateway.util.CreditCardTypeCheckUtil

getCustomer() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

Any customer information that relates to this transaction

getCustomer() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

Any customer information that relates to this transaction

getCustomerCredits() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

Any customer credit accounts that have been processed.

getCustomerCredits() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

Any customer credit accounts that have been processed.

getCustomerId() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

getCustomerService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayCustomerServiceProvider

getCustomerService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayCustomerServiceProvider

Returns the first PaymentGatewayCustomerService that matches the given PaymentGatewayType.

getCustomerServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayCustomerServiceProvider

getCvv() - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

getDateRecorded() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

The timestamp when this transaction response was recorded

getDeclineType() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

The type of transaction decline (hard vs soft decline)

getDefaultHandler() - Method in class com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceMonitor

getDescription() - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

getEmail() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

getEmailAddress() - Method in class com.broadleafcommerce.paymentgateway.domain.Address

getExpDate() - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

getExpMonth() - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

getExpYear() - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

getFailureReportingThreshold() - Method in class com.broadleafcommerce.paymentgateway.service.AbstractExternalPaymentGatewayCall

getFailureReportingThreshold() - Method in interface com.broadleafcommerce.paymentgateway.service.FailureCountExposable

getFailureReportingThreshold() - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughConfiguration

getFailureReportingThreshold() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

All payment gateway classes that intend to make an external call, either manually from an HTTP Post or through an SDK which makes its own external call, should extend the AbstractExternalPaymentGatewayCall class.

getFailureType() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

The type of transaction failure (TransactionFailureType).

getFax() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

getFirstName() - Method in class com.broadleafcommerce.paymentgateway.domain.Address

getFirstName() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

getFraudService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayFraudServiceProvider

getFraudService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayFraudServiceProvider

Returns the first PaymentGatewayFraudService that matches the given PaymentGatewayType.

getFraudServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayFraudServiceProvider

getFrequency() - Method in class com.broadleafcommerce.paymentgateway.domain.Subscription

How often the customer will be charged

getFriendlyName() - Method in enum com.broadleafcommerce.paymentgateway.domain.enums.CreditCardType

getFriendlyName() - Method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentLogEventTypes

getFriendlyName() - Method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

getFriendlyName() - Method in enum com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

getFriendlyName() - Method in enum com.broadleafcommerce.paymentgateway.domain.enums.PaymentDeclineType

getFriendlyName() - Method in enum com.broadleafcommerce.paymentgateway.domain.enums.PaymentGatewayRequestType

getFriendlyName() - Method in interface com.broadleafcommerce.paymentgateway.domain.enums.PaymentLogEventType

An easily readable representation of the event type.

getFriendlyName() - Method in interface com.broadleafcommerce.paymentgateway.domain.enums.PaymentType

getFriendlyName() - Method in enum com.broadleafcommerce.paymentgateway.vendor.service.type.ServiceStatusType

getFullName() - Method in class com.broadleafcommerce.paymentgateway.domain.Address

getGatewayRequestType() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

Additional information about the request that can be used by the gateway implementation to inform/direct portions of its functionality

getGatewayResponseCode() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

The response code provided by the payment gateway which may represent a success or failure

getGatewayType() - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughConfiguration

getGatewayType() - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughPaymentValidator

getGatewayType() - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughTransactionService

getGatewayType() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTypeAware

Each payment module should have a unique implementation of PaymentGatewayType with only a single type.

getGiftCards() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

Any gift cards that have been processed.

getGiftCards() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

Any gift cards that have been processed.

getHostedService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayHostedServiceProvider

getHostedService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayHostedServiceProvider

Returns the first PaymentGatewayHostedService that matches the given PaymentGatewayType.

getHostedServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayHostedServiceProvider

getItemTotal() - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

getLastFour() - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

getLastName() - Method in class com.broadleafcommerce.paymentgateway.domain.Address

getLastName() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

getLength() - Method in class com.broadleafcommerce.paymentgateway.util.UnmaskRange

getLineItems() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

The items associated to the transaction's related order

getMaskedAccountNumber() - Method in class com.broadleafcommerce.paymentgateway.domain.CustomerCredit

getMaskedCardNumber() - Method in class com.broadleafcommerce.paymentgateway.domain.GiftCard

getMessage() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

Message describing the result of the transaction

getMobile() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

getName() - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

getNumberOfInstallments() - Method in class com.broadleafcommerce.paymentgateway.domain.Subscription

The number of times that the customer will be charged

getOrderDescription() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

A description of the order associated with this transaction

getOrderId() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

getOrderId() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

The Order ID that this transaction is associated with

getOrderSubtotal() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

The order's total usually excluding adjustments, tax, and shipping.

getParent() - Method in class com.broadleafcommerce.paymentgateway.domain.Address

getParent() - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

getParent() - Method in class com.broadleafcommerce.paymentgateway.domain.CustomerCredit

getParent() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

getParent() - Method in class com.broadleafcommerce.paymentgateway.domain.GiftCard

getParent() - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

getParent() - Method in class com.broadleafcommerce.paymentgateway.domain.Subscription

getPaymentGatewayConfigurations() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayConfigurationProvider

getPaymentGatewayType() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

The Payment Gateway Type that this transaction response represents

getPaymentId() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

The Payment ID that this transaction is associated with

getPaymentId() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

The Payment ID that this transaction is associated with

getPaymentRequestFromCurrentCustomer() - Method in interface com.broadleafcommerce.paymentgateway.service.CurrentCustomerPaymentRequestService

Returns a PaymentRequest based on all the information from the current customer in the system, like one on threadlocal

getPaymentToken() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

If this is a Tokenization request, this will hold the token sent back from the gateway

getPaymentType() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

The Type of Payment that this transaction response represents

getPaymentType() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

The Type of Payment that this transaction response represents

getPaymentValidator(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayPaymentValidationProvider

getPaymentValidator(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayPaymentValidationProvider

Returns the first PaymentGatewayPaymentValidator that matches the given PaymentGatewayType.

getPaymentValidators() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayPaymentValidationProvider

getPhone() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

getPhoneNumber() - Method in class com.broadleafcommerce.paymentgateway.domain.Address

getPositionType() - Method in class com.broadleafcommerce.paymentgateway.util.UnmaskRange

getPostalCode() - Method in class com.broadleafcommerce.paymentgateway.domain.Address

getQuantity() - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

getRawResponse() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

A string representation of the response that came from the gateway.

getRecurringAmount() - Method in class com.broadleafcommerce.paymentgateway.domain.Subscription

The amount that must be paid for each billing cycle

getReportingService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayReportingServiceProvider

getReportingService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayReportingServiceProvider

Returns the first PaymentGatewayReportingService that matches the given PaymentGatewayType.

getReportingServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayReportingServiceProvider

getResponseMap() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

A more convenient representation of PaymentResponse.rawResponse to hold the response from the gateway.

getRollbackService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayRollbackServiceProvider

getRollbackService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayRollbackServiceProvider

Returns the first PaymentGatewayRollbackService that matches the given PaymentGatewayType.

getRollbackServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayRollbackServiceProvider

getServiceHandlers() - Method in class com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceMonitor

getServiceName() - Method in interface com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceStatusDetectable

getServiceStatus() - Method in class com.broadleafcommerce.paymentgateway.service.AbstractExternalPaymentGatewayCall

getServiceStatus() - Method in interface com.broadleafcommerce.paymentgateway.service.FailureCountExposable

getServiceStatus() - Method in interface com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceStatusDetectable

getShippingTotal() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

The order's total shipping cost

getShipTo() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

If shipping information is captured on the gateway, the values sent back will be put here

getShipTo() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

If shipping information is captured on the gateway, the values sent back will be put here

getShortDescription() - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

getSiteBaseUrl() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

The base url of the site that is making this payment request.

getSourceId() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

The id of the entity that caused this payment to be created.

getSourceType() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

Describes the origination of the payment.

getStartDate() - Method in class com.broadleafcommerce.paymentgateway.domain.Subscription

Start of when this subscription should be active.

getStateRegion() - Method in class com.broadleafcommerce.paymentgateway.domain.Address

getSubscription() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

Any information required to execute recurring billing

getSubscriptionService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewaySubscriptionServiceProvider

getSubscriptionService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewaySubscriptionServiceProvider

Returns the first PaymentGatewaySubscriptionService that matches the given PaymentGatewayType.

getSubscriptionServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewaySubscriptionServiceProvider

getSupportedFeatures() - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughConfiguration

getSupportedFeatures() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

The set of features this gateway supports such as 3D Secure, multi-use payment methods, and pay later.

getSupportedTransactionTypes() - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughConfiguration

getSupportedTransactionTypes() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

Returns the set of TransactionTypes that the gateway supports.

getSystemId() - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

getTax() - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

getTaxTotal() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

The order's total tax cost

getThreeDSecureVerificationUrl() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

The gateway-provided url where the customer must verify that they are in fact the owner of the payment method.

getTotal() - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

getTransactionConfirmationService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayTransactionConfirmationServiceProvider

getTransactionConfirmationService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayTransactionConfirmationServiceProvider

Returns the first PaymentGatewayTransactionConfirmationService that matches the given PaymentGatewayType.

getTransactionConfirmationServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayTransactionConfirmationServiceProvider

getTransactionReferenceId() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

The transaction reference that is passed to the payment gateway.

getTransactionReferenceId() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

The transaction reference that is passed to the payment gateway.

getTransactionService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayTransactionServiceProvider

getTransactionService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayTransactionServiceProvider

Returns the first PaymentGatewayTransactionService that matches the given PaymentGatewayType.

getTransactionServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayTransactionServiceProvider

getTransactionTotal() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

The order's total cost including tax & shipping charges

getTransactionType() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

The Transaction Type of the Payment that this response represents

getTransparentRedirectService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayTransparentRedirectServiceProvider

getTransparentRedirectService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayTransparentRedirectServiceProvider

Returns the first PaymentGatewayTransparentRedirectService that matches the given PaymentGatewayType.

getTransparentRedirectServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayTransparentRedirectServiceProvider

getTypeFactory() - Method in class com.broadleafcommerce.paymentgateway.util.DefaultPaymentResponseUtil

getUpdateCustomerPaymentTokenCancelURLFieldKey(PaymentResponse) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransparentRedirectService

Return the PaymentResponse.getResponseMap() key that corresponds to updating the customer token cancel url

getUpdateCustomerPaymentTokenReturnURLFieldKey(PaymentResponse) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransparentRedirectService

Return the PaymentResponse.getResponseMap() key that corresponds to updating the customer token return url

getWebResponseService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayWebResponseServiceProvider

getWebResponseService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayWebResponseServiceProvider

Returns the first PaymentGatewayWebResponseService that matches the given PaymentGatewayType.

getWebResponseServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayWebResponseServiceProvider

getWebsite() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

GiftCard<T> - Class in com.broadleafcommerce.paymentgateway.domain

GiftCard() - Constructor for class com.broadleafcommerce.paymentgateway.domain.GiftCard

GiftCard(T) - Constructor for class com.broadleafcommerce.paymentgateway.domain.GiftCard

giftCard() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

You should only call this once, as it will create a new gift card if called more than once.

giftCard() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

H

handlesAuthorize() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

handlesAuthorizeAndCapture() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

handlesCapture() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

handlesMultiplePayments() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

Deprecated.

This is not relevant for the gateways

handlesMultipleShipment() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

Deprecated.

This is not relevant for gateways

handlesPartialCapture() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

handlesRecurringPayment() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

handlesRefund() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

handlesReverseAuthorize() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

handlesSavedCustomerPayment() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

handleStatus(String, ServiceStatusType) - Method in class com.broadleafcommerce.paymentgateway.vendor.service.monitor.handler.CompositeStatusHandler

handleStatus(String, ServiceStatusType) - Method in class com.broadleafcommerce.paymentgateway.vendor.service.monitor.handler.LogStatusHandler

handleStatus(String, ServiceStatusType) - Method in interface com.broadleafcommerce.paymentgateway.vendor.service.monitor.StatusHandler

handleStatusChange(ServiceStatusDetectable, ServiceStatusType) - Method in class com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceMonitor

handlesVoid() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

I

incrementFailure() - Method in class com.broadleafcommerce.paymentgateway.service.AbstractExternalPaymentGatewayCall

incrementFailure() - Method in interface com.broadleafcommerce.paymentgateway.service.FailureCountExposable

init() - Method in class com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceMonitor

initiateCheckout(Long) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayCheckoutService

Initiates the checkout process for a given orderId.

InvalidPaymentConfigurationException - Exception in com.broadleafcommerce.paymentgateway.service.exception

Exception denoting that a Payment representation is considered invalid.

InvalidPaymentConfigurationException(String) - Constructor for exception com.broadleafcommerce.paymentgateway.service.exception.InvalidPaymentConfigurationException

isAPIRateLimitError(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

isAuthorize(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes

isAuthorizeAndCapture(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes

isCapture(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes

isCheckoutTransactionExternal() - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughConfiguration

isCheckoutTransactionExternal() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

Whether the checkout transaction occurs externally such as for transparent redirect or MyFatoorah.

isCompleteCheckoutOnCallback() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

Sets whether or not this module should complete checkout on callback.

isCompleteCheckoutOnCallback() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

Sets whether or not this module should complete checkout on callback.

isDetachedCredit(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes

isFinalPayment() - Method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

isFinalPayment() - Method in interface com.broadleafcommerce.paymentgateway.domain.enums.PaymentType

isGatewayConfigurationError(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

isGatewayCredentialsError(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

isGatewayError(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

isHandlerCompatible(PaymentGatewayType) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayResolver

Used by Transparent Redirect Solutions that utilize Thymeleaf Processors and Expressions.

isHardDecline(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.PaymentDeclineType

isInternalError(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

isInvalidPaymentMethod(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

isInvalidRequest(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

isNetworkError(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

isPerformAuthorizeAndCapture() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

Deprecated.

Check PaymentGatewayConfiguration.getCheckoutTransactionType(). The value is not necessarily restricted to only DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE or DefaultTransactionTypes.AUTHORIZE.

isProcessingFailure(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

isRefund(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes

isRequires3DSVerification(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

isRequiresAdditionalAction(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

isResponseValidationFailure(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

isReverseAuth(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes

isSettle(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes

isSoftDecline(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.PaymentDeclineType

isSuccessful() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

Whether or not the transaction on the gateway was successful.

isUp - Variable in class com.broadleafcommerce.paymentgateway.service.AbstractExternalPaymentGatewayCall

isValid() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

Whether or not this response was tampered with.

isVoid(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes

itemTotal(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

L

lastFour(String) - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard

lastName(String) - Method in class com.broadleafcommerce.paymentgateway.domain.Address

lastName(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

LineItem - Class in com.broadleafcommerce.paymentgateway.domain

LineItem(PaymentRequest) - Constructor for class com.broadleafcommerce.paymentgateway.domain.LineItem

lineItem() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

LogStatusHandler - Class in com.broadleafcommerce.paymentgateway.vendor.service.monitor.handler

LogStatusHandler() - Constructor for class com.broadleafcommerce.paymentgateway.vendor.service.monitor.handler.LogStatusHandler

lookupOrderNumberFromOrderId(PaymentResponse) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayCheckoutService

Looks up the order number for a particular order id from the PaymentResponse.

M

markPaymentAsInvalid(Long) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayCheckoutService

Marks a given order payment as invalid.

mask(String) - Method in class com.broadleafcommerce.paymentgateway.util.AccountNumberMaskUtil

maskedAccountNumber(String) - Method in class com.broadleafcommerce.paymentgateway.domain.CustomerCredit

maskedCardNumber(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GiftCard

message(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

mobile(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

N

name() - Method in interface com.broadleafcommerce.paymentgateway.domain.enums.TransactionFailureType

name() - Method in interface com.broadleafcommerce.paymentgateway.domain.enums.TransactionType

name(String) - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

numberOfInstallments - Variable in class com.broadleafcommerce.paymentgateway.domain.Subscription

The number of times that the customer will be charged

numberOfInstallments(String) - Method in class com.broadleafcommerce.paymentgateway.domain.Subscription

O

orderDescription(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

orderId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

orderId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

orderSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

OVERRIDE_CREATE_TOKEN_CANCEL_URL - Static variable in class com.broadleafcommerce.paymentgateway.constants.TransparentRedirectConstants

OVERRIDE_CREATE_TOKEN_RETURN_URL - Static variable in class com.broadleafcommerce.paymentgateway.constants.TransparentRedirectConstants

OVERRIDE_UPDATE_TOKEN_CANCEL_URL - Static variable in class com.broadleafcommerce.paymentgateway.constants.TransparentRedirectConstants

OVERRIDE_UPDATE_TOKEN_RETURN_URL - Static variable in class com.broadleafcommerce.paymentgateway.constants.TransparentRedirectConstants

P

parent - Variable in class com.broadleafcommerce.paymentgateway.domain.Subscription

PassthroughConfiguration - Interface in com.broadleafcommerce.paymentgateway.service.passthrough

PassthroughPaymentValidator - Interface in com.broadleafcommerce.paymentgateway.service.passthrough

PassthroughTransactionService - Interface in com.broadleafcommerce.paymentgateway.service.passthrough

PaymentAdditionalFieldType - Enum in com.broadleafcommerce.paymentgateway.domain.enums

PaymentDeclineType - Enum in com.broadleafcommerce.paymentgateway.domain.enums

When a payment gateway declines a payment, this value indicates whether it is a "soft" (insufficient funds) or "hard" (stolen card) decline.

PaymentException - Exception in com.broadleafcommerce.paymentgateway.service.exception

PaymentException() - Constructor for exception com.broadleafcommerce.paymentgateway.service.exception.PaymentException

PaymentException(String, Throwable) - Constructor for exception com.broadleafcommerce.paymentgateway.service.exception.PaymentException

PaymentException(String) - Constructor for exception com.broadleafcommerce.paymentgateway.service.exception.PaymentException

PaymentException(Throwable) - Constructor for exception com.broadleafcommerce.paymentgateway.service.exception.PaymentException

PaymentGatewayCheckoutService - Interface in com.broadleafcommerce.paymentgateway.service

This is designed as a generic contract for allowing payment modules to add payments to an order represented in Broadleaf while still staying decoupled from any of the Broadleaf core framework concepts.

PaymentGatewayClientTokenService - Interface in com.broadleafcommerce.paymentgateway.service

The intention of this API is to generate the necessary parameters and fields needed by the payment gateway's JavaScript library in order to create a tokenization request.

PaymentGatewayClientTokenServiceProvider - Interface in com.broadleafcommerce.paymentgateway.service.provider

This represents the main service bus for retrieving payment gateway service implementations to execute service calls programmatically.

PaymentGatewayCommonUtilAutoConfiguration - Class in com.broadleafcommerce.paymentgateway.util.autoconfigure

PaymentGatewayCommonUtilAutoConfiguration() - Constructor for class com.broadleafcommerce.paymentgateway.util.autoconfigure.PaymentGatewayCommonUtilAutoConfiguration

PaymentGatewayConfiguration - Interface in com.broadleafcommerce.paymentgateway.service

This API is intended to define the specific configuration parameters that this gateway implementation currently supports.

PaymentGatewayConfigurationProvider - Interface in com.broadleafcommerce.paymentgateway.service.provider

This represents the main service bus for retrieving payment gateway service implementations to execute service calls programmatically.

PaymentGatewayCreditCardService - Interface in com.broadleafcommerce.paymentgateway.service

Several payment gateways allow you to manage Customer and Credit Card Information from the gateway allowing you to create a transaction from the tokenized customer or payment method at a later date.

PaymentGatewayCreditCardServiceProvider - Interface in com.broadleafcommerce.paymentgateway.service.provider

This represents the main service bus for retrieving payment gateway service implementations to execute service calls programmatically.

PaymentGatewayCustomerService - Interface in com.broadleafcommerce.paymentgateway.service

Several payment gateways allow you to manage Customer and Credit Card Information from the gateway allowing you to create a transaction from the tokenized customer or payment method at a later date.

PaymentGatewayCustomerServiceProvider - Interface in com.broadleafcommerce.paymentgateway.service.provider

This represents the main service bus for retrieving payment gateway service implementations to execute service calls programmatically.

PaymentGatewayFraudService - Interface in com.broadleafcommerce.paymentgateway.service

Certain Payment Integrations allow you to use Fraud Services like Address Verification and Buyer Authentication, such as PayPal Payments Pro (PayFlow Edition)

PaymentGatewayFraudServiceProvider - Interface in com.broadleafcommerce.paymentgateway.service.provider

This represents the main service bus for retrieving payment gateway service implementations to execute service calls programmatically.

PaymentGatewayHostedService - Interface in com.broadleafcommerce.paymentgateway.service

Certain Payment Integrations allow you to use a Hosted Solution, such as PayPal Express and SagePay Form.

PaymentGatewayHostedServiceProvider - Interface in com.broadleafcommerce.paymentgateway.service.provider

This represents the main service bus for retrieving payment gateway service implementations to execute service calls programmatically.

PaymentGatewayPaymentValidationProvider - Interface in com.broadleafcommerce.paymentgateway.service.provider

Simple class to help gather PaymentGatewayPaymentValidator implementations by PaymentGatewayTypeAware.getGatewayType().

PaymentGatewayPaymentValidator - Interface in com.broadleafcommerce.paymentgateway.service

Validator meant to ensure that Payment objects are sufficiently configured, allowing transactions to be executed via the related PaymentGatewayTransactionService implementation.

PaymentGatewayReportingService - Interface in com.broadleafcommerce.paymentgateway.service

This API provides the ability to get the status of a Transaction after it has been submitted to the Gateway.

PaymentGatewayReportingServiceProvider - Interface in com.broadleafcommerce.paymentgateway.service.provider

This represents the main service bus for retrieving payment gateway service implementations to execute service calls programmatically.

PaymentGatewayRequestType - Enum in com.broadleafcommerce.paymentgateway.domain.enums

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.

PaymentGatewayResolver - Interface in com.broadleafcommerce.paymentgateway.service

PaymentGatewayRollbackService - Interface in com.broadleafcommerce.paymentgateway.service

This API allows each module to provide its own implementation for rollback.

PaymentGatewayRollbackServiceProvider - Interface in com.broadleafcommerce.paymentgateway.service.provider

This represents the main service bus for retrieving payment gateway service implementations to execute service calls programmatically.

PaymentGatewaySubscriptionService - Interface in com.broadleafcommerce.paymentgateway.service

Some gateways allow you to create a form of recurring billing by creating a subscription profile.

PaymentGatewaySubscriptionServiceProvider - Interface in com.broadleafcommerce.paymentgateway.service.provider

This represents the main service bus for retrieving payment gateway service implementations to execute service calls programmatically.

PaymentGatewayTransactionConfirmationService - Interface in com.broadleafcommerce.paymentgateway.service

This API is intended to be called by the Checkout Workflow to confirm all Payments on the order that have not yet been confirmed/finalized.

PaymentGatewayTransactionConfirmationServiceProvider - Interface in com.broadleafcommerce.paymentgateway.service.provider

This represents the main service bus for retrieving payment gateway service implementations to execute service calls programmatically.

PaymentGatewayTransactionService - Interface in com.broadleafcommerce.paymentgateway.service

This is an interface that provides the basic functions to create billable credit card transactions

PaymentGatewayTransactionServiceProvider - Interface in com.broadleafcommerce.paymentgateway.service.provider

This represents the main service bus for retrieving payment gateway service implementations to execute service calls programmatically.

PaymentGatewayTransparentRedirectService - Interface in com.broadleafcommerce.paymentgateway.service

The purpose of this class, is to provide an API that will create any gateway specific parameters needed for a Transparent Redirect/Silent Order Post etc...

PaymentGatewayTransparentRedirectServiceProvider - Interface in com.broadleafcommerce.paymentgateway.service.provider

This represents the main service bus for retrieving payment gateway service implementations to execute service calls programmatically.

PaymentGatewayType - Interface in com.broadleafcommerce.paymentgateway.domain.enums

Identifies the payment gateway related to a given PaymentRequest or PaymentResponse.

paymentGatewayType(PaymentGatewayType) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

PaymentGatewayTypeAware - Interface in com.broadleafcommerce.paymentgateway.service

This API is intended to identify the related PaymentGatewayType so that the resource can be easily identified by the various provider services (PaymentGatewayConfigurationProvider, PaymentGatewayTransactionServiceProvider, PaymentGatewayRollbackServiceProvider, etc.).

PaymentGatewayWebResponsePrintService - Interface in com.broadleafcommerce.paymentgateway.service.webresponse.servlet

This is a utility service that aids in translating the Request Attribute and Request Parameters to a single String.

PaymentGatewayWebResponseService - Interface in com.broadleafcommerce.paymentgateway.service.webresponse.servlet

The purpose of this class, is to provide an API that will translate a web response returned from a Payment Gateway into a PaymentResponse

PaymentGatewayWebResponseServiceProvider - Interface in com.broadleafcommerce.paymentgateway.service.provider

This represents the main service bus for retrieving payment gateway service implementations to execute service calls programmatically.

paymentId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

paymentId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

PaymentLogEventType - Interface in com.broadleafcommerce.paymentgateway.domain.enums

Identifies the log event type for a payment interaction.

PaymentRequest - Class in com.broadleafcommerce.paymentgateway.domain

A DTO that is comprised of all the information that is sent to a Payment Gateway to complete a transaction.

PaymentRequest() - Constructor for class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

PaymentResponse - Class in com.broadleafcommerce.paymentgateway.domain

The DTO object that represents the response coming back from any call to the Gateway.

PaymentResponse(PaymentType, PaymentGatewayType) - Constructor for class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

PaymentResponse() - Constructor for class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

paymentResponseUtil(TypeFactory) - Method in class com.broadleafcommerce.paymentgateway.util.autoconfigure.PaymentGatewayCommonUtilAutoConfiguration

PaymentResponseUtil - Interface in com.broadleafcommerce.paymentgateway.util

paymentToken(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

PaymentType - Interface in com.broadleafcommerce.paymentgateway.domain.enums

This represents types of payments that can be applied to a cart.

paymentType(PaymentType) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

paymentType(PaymentType) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

phone(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

phoneNumber(String) - Method in class com.broadleafcommerce.paymentgateway.domain.Address

populateBillTo(PaymentResponse, Address<PaymentRequest>) - Method in class com.broadleafcommerce.paymentgateway.util.DefaultPaymentResponseUtil

populateCustomer(PaymentResponse, GatewayCustomer<PaymentRequest>) - Method in class com.broadleafcommerce.paymentgateway.util.DefaultPaymentResponseUtil

populateShipTo(PaymentResponse, Address<PaymentRequest>) - Method in class com.broadleafcommerce.paymentgateway.util.DefaultPaymentResponseUtil

postalCode(String) - Method in class com.broadleafcommerce.paymentgateway.domain.Address

printRequest(HttpServletRequest) - Method in class com.broadleafcommerce.paymentgateway.service.webresponse.servlet.DefaultPaymentGatewayWebResponsePrintService

printRequest(HttpServletRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.webresponse.servlet.PaymentGatewayWebResponsePrintService

process(T) - Method in class com.broadleafcommerce.paymentgateway.service.AbstractExternalPaymentGatewayCall

process(T) - Method in interface com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceStatusDetectable

Q

quantity(int) - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

R

rawResponse(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

recurringAmount - Variable in class com.broadleafcommerce.paymentgateway.domain.Subscription

The amount that must be paid for each billing cycle

recurringAmount(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.Subscription

refund(PaymentRequest) - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughTransactionService

refund(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransactionService

Responsible for executing a DefaultTransactionTypes.REFUND transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.

REQUEST_ATTRIBUTES - Static variable in class com.broadleafcommerce.paymentgateway.service.webresponse.servlet.DefaultPaymentGatewayWebResponsePrintService

REQUEST_PARAMETERS - Static variable in class com.broadleafcommerce.paymentgateway.service.webresponse.servlet.DefaultPaymentGatewayWebResponsePrintService

requestHostedEndpoint(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayHostedService

requestPayerAuthentication(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayFraudService

Certain Gateways integrate with Visa's Verified by Visa and MasterCard's SecureCode API If the buyer is enrolled in such a service, we will need to redirect the buyer's browser to the ACS ( Access Control Server, eg.

resolvePaymentGateway(WebRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayResolver

Resolves a PaymentGatewayType based on a WebRequest

responseMap(String, String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

retrieveCustomerAttributeFromCurrentCustomer(String) - Method in interface com.broadleafcommerce.paymentgateway.service.CurrentCustomerPaymentRequestService

retrieve a "customer attribute" value on the current customer in the system

retrieveCustomerAttributeFromCustomer(Long, String) - Method in interface com.broadleafcommerce.paymentgateway.service.CurrentCustomerPaymentRequestService

retrieve a "customer attribute" value based on the customer id in the system

reverseAuthorize(PaymentRequest) - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughTransactionService

reverseAuthorize(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransactionService

Responsible for executing a DefaultTransactionTypes.REVERSE_AUTH transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.

rollbackAuthorize(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayRollbackService

rollbackAuthorizeAndCapture(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayRollbackService

rollbackCapture(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayRollbackService

rollbackRefund(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayRollbackService

S

serviceHandlers - Variable in class com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceMonitor

ServiceMonitor - Class in com.broadleafcommerce.paymentgateway.vendor.service.monitor

ServiceMonitor() - Constructor for class com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceMonitor

ServiceStatusDetectable<T> - Interface in com.broadleafcommerce.paymentgateway.vendor.service.monitor

ServiceStatusType - Enum in com.broadleafcommerce.paymentgateway.vendor.service.type

An extendible enumeration of service status types.

setCheckoutTransactionType(String) - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughConfiguration

Set the TransactionType that should be performed during checkout.

setCheckoutTransactionType(String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

Set the TransactionType that should be performed during checkout.

setDefaultHandler(StatusHandler) - Method in class com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceMonitor

setFailureReportingThreshold(int) - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughConfiguration

setFailureReportingThreshold(int) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

All payment gateway classes that intend to make an external call, either manually from an HTTP Post or through an SDK which makes its own external call, should extend the AbstractExternalPaymentGatewayCall class.

setPerformAuthorizeAndCapture(boolean) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayConfiguration

Deprecated.

Use PaymentGatewayConfiguration.setCheckoutTransactionType(String)

setServiceHandlers(Map<ServiceStatusDetectable, StatusHandler>) - Method in class com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceMonitor

shippingTotal(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

shipTo() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

You should only call this once, as it will create a new customer if called more than once.

shipTo() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

shipToPopulated() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

shortDescription(String) - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

sourceId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

sourceType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

startDate - Variable in class com.broadleafcommerce.paymentgateway.domain.Subscription

Start of when this subscription should be active.

startDate(Instant) - Method in class com.broadleafcommerce.paymentgateway.domain.Subscription

stateRegion(String) - Method in class com.broadleafcommerce.paymentgateway.domain.Address

StatusHandler - Interface in com.broadleafcommerce.paymentgateway.vendor.service.monitor

statusMap - Variable in class com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceMonitor

subscription() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

You should only call this once, as it will create a new subscription if called more than once.

Subscription<T> - Class in com.broadleafcommerce.paymentgateway.domain

Subscription() - Constructor for class com.broadleafcommerce.paymentgateway.domain.Subscription

Subscription(T) - Constructor for class com.broadleafcommerce.paymentgateway.domain.Subscription

subscriptionPopulated() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

subscriptionPopulated() - Method in class com.broadleafcommerce.paymentgateway.domain.Subscription

successful(boolean) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

systemId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

T

tax(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

taxTotal(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

threeDSecureVerificationUrl(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

total(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem

TransactionFailureType - Interface in com.broadleafcommerce.paymentgateway.domain.enums

The TransactionFailureType is used to identify the category of failure that was encountered while processing a payment gateway transaction

transactionReferenceId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

transactionReferenceId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

transactionTotal(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

TransactionType - Interface in com.broadleafcommerce.paymentgateway.domain.enums

The TransactionType is used to represent the types of operations/transactions that could occur against a single payment.

transactionType(TransactionType) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

translateWebResponse(HttpServletRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.webresponse.servlet.PaymentGatewayWebResponseService

TransparentRedirectConstants - Class in com.broadleafcommerce.paymentgateway.constants

TransparentRedirectConstants() - Constructor for class com.broadleafcommerce.paymentgateway.constants.TransparentRedirectConstants

U

UnmaskRange - Class in com.broadleafcommerce.paymentgateway.util

UnmaskRange(int, int) - Constructor for class com.broadleafcommerce.paymentgateway.util.UnmaskRange

updateCustomerPaymentFromResponseDTO(PaymentResponse, PaymentGatewayConfiguration) - Method in interface com.broadleafcommerce.paymentgateway.service.CustomerPaymentGatewayService

updateCustomerPaymentTokenForm(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransparentRedirectService

updateGatewayCreditCard(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayCreditCardService

updateGatewayCustomer(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayCustomerService

updateGatewaySubscription(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewaySubscriptionService

V

valid(boolean) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

validatePayment(Payment) - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughPaymentValidator

validatePayment(Payment) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayPaymentValidator

Validates that the Payment is sufficiently configured to execute transactions for the gateway integration.

valueOf(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.CreditCardType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentGatewayTypes

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentLogEventTypes

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.PaymentDeclineType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.PaymentGatewayRequestType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.paymentgateway.vendor.service.type.ServiceStatusType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.CreditCardType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentGatewayTypes

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentLogEventTypes

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.PaymentDeclineType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.PaymentGatewayRequestType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.paymentgateway.vendor.service.type.ServiceStatusType

Returns an array containing the constants of this enum type, in the order they are declared.

voidPayment(PaymentRequest) - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughTransactionService

voidPayment(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransactionService

Responsible for executing a DefaultTransactionTypes.VOID transaction against the payment gateway, based on the provided PaymentRequest, & returning the transaction's results in the form of a PaymentResponse.

W

website(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer

A B C D E F G H I L M N O P Q R S T U V W