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

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

ACCOUNT_CREDIT_NUM - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

ACCOUNT_TYPE - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

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

addAddress(String, Address<PaymentValidationRequest>) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

Adds an Address to the map, identified by the provided addressType.

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 - 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.Address

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

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

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

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

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

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

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

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

addressByType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

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

AMEX - com.broadleafcommerce.paymentgateway.domain.enums.CreditCardType

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

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

API_RATE_LIMIT_ERROR - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

An error that occurs when too many requests hit the gateway's API too quickly

APPLE_PAY - com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

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

AUTH_CODE - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

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

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.

AUTHORIZE - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes

Funds have been authorized for capture.

AUTHORIZE_AND_CAPTURE - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes

Funds have been captured/authorized all at once.

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

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.

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

B

BANK_ACCOUNT - com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

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

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

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

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

buildFailedWebhookResponse(Exception) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayWebhookHandler

Builds & returns a ResponseEntity meant to communicate to the gateway that the webhook request was unsuccessfully processed.

buildInitialPaymentResponse(GatewayTransactionResponse, PaymentGatewayType) - Method in class com.broadleafcommerce.paymentgateway.util.DefaultPaymentResponseUtil

buildInitialPaymentResponse(GatewayTransactionResponse, PaymentGatewayType) - Method in interface com.broadleafcommerce.paymentgateway.util.PaymentResponseUtil

Builds and populates a PaymentResponse based on the provided GatewayTransactionResponse and PaymentGatewayType

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

buildPaymentResponse(GatewayTransactionResponse) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransactionResponseService

Builds a PaymentResponse from the GatewayTransactionResponse, to save transaction results from the gateway.

buildSuccessfulWebhookResponse() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayWebhookHandler

Builds & returns a ResponseEntity meant to communicate to the gateway that the webhook request was successfully processed.

BUY_NOW_PAY_LATER - com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType

Whether the gateway supports a buy-now-pay-later feature.

C

canEqual(Object) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

canEqual(Object) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

canEqual(Object) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

canEqual(Object) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionIdentifier

canEqual(Object) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

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

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.

CAPTURE - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes

Funds have been charged/submitted/debited from the customer and payment is complete.

CARD_TYPE - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

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

CHECK - com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

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

COD - com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

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.properties - package com.broadleafcommerce.paymentgateway.properties

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.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

convertToPaymentResponse(HttpHeaders, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayWebhookHandler

Builds & returns a pair of TransactionIdentifier & PaymentResponse based on the contents of the webhook request.

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

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

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

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

CREDIT_CARD - com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

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

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

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.GatewayTransactionResponse

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

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() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

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

CUSTOMER_CREDIT - com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

CUSTOMER_PAYMENT - com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

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

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

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

DECLINE_TYPE - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

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

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

Passthrough Transaction Service intended to be used for Testing Purposes.

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

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

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

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

DefaultPaymentGatewayResourceProvider(List<PaymentGatewayConfiguration>, List<PaymentGatewayTransactionService>, List<PaymentGatewayRollbackService>, List<PaymentGatewayReportingService>, List<PaymentGatewayCustomerService>, List<PaymentGatewayHostedService>, List<PaymentGatewayPaymentValidator>, List<PaymentGatewayTransactionResponseService>, List<PaymentGatewayTransactionResponseValidator>) - Constructor for class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider

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

The default set of payment gateway types.

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

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

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

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

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

DETACHED_CREDIT - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes

Some payment processors allow you to issue credit to a customer that is not tied to an initial DefaultTransactionTypes.AUTHORIZE or DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE transaction.

detachedCredit(PaymentRequest) - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughTestingTransactionService

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

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

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

DINERSCLUB_CARTEBLANCHE - com.broadleafcommerce.paymentgateway.domain.enums.CreditCardType

DISCOVER - com.broadleafcommerce.paymentgateway.domain.enums.CreditCardType

DiscriminatedProperties<P> - Class in com.broadleafcommerce.paymentgateway.properties

DiscriminatedProperties() - Constructor for class com.broadleafcommerce.paymentgateway.properties.DiscriminatedProperties

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

DOWN - com.broadleafcommerce.paymentgateway.vendor.service.type.ServiceStatusType

E

ELECTRONIC_CHECK - com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

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

EMAIL - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

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

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

ENROUTE - com.broadleafcommerce.paymentgateway.domain.enums.CreditCardType

equals(Object) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

equals(Object) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

equals(Object) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

equals(Object) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionIdentifier

equals(Object) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

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

The exception is thrown when an error occurred during token exchanging.

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

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

exchangeSingleUseTokenIfApplicable(Map<String, String>, String, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewaySavedPaymentMethodService

Exchanges the short-lived (typically single-use) payment token for a long-lived, multi-use token.

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

The exception is thrown when an error occurred while exchanging the digital wallet token.

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

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

EXP_DATE - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

EXP_MONTH - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

EXP_YEAR - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

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

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

The exception is thrown when an error occurred during fetching transaction results.

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

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

FINISHED - com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentLogEventTypes

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

GATEWAY_CONFIGURATION_ERROR - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

The gateway is incorrectly configured or is not configured to handle the attempted type of request

GATEWAY_CREDENTIALS_ERROR - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

The provided payment gateway credentials are not valid

GATEWAY_ERROR - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

There was an unexpected error with the payment gateway itself.

GATEWAY_TYPE - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

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

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

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

GatewayTransactionResponse - Class in com.broadleafcommerce.paymentgateway.domain

A DTO that contains information needed to save transaction data from a payment gateway.

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

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

get3DSTransactionLookupService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider

get3DSTransactionLookupService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayResourceProvider

Returns the implementation of PaymentGateway3DSTransactionLookupService for the specified gateway type.

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

getAddress(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

Gathers one of the payment's related addresses by type

getAddressByType() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

The collection of related addresses that may include billing or shipping addresses

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.

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

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

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

The transaction amount that was processed by the gateway

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

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

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

The amount related to this transaction.

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

The amount for which this payment is allotted.

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

The amount related to this transaction.

getApplication() - Method in class com.broadleafcommerce.paymentgateway.properties.DiscriminatedProperties

getApplicationId() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

The application id

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

The application id associated with the current request.

getAttributes() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

Map of specific attributes that have been gathered from the raw response.

getAttributes() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

General use map to capture any additional attributes needed for this PaymentValidationRequest

getAttributes() - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

Map of additional attributes that can be used to identify the transaction.

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

The billing address associated with this transaction

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

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

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.DefaultPaymentGatewayResourceProvider

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

Returns the first PaymentGatewayConfiguration that matches the given PaymentGatewayType.

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

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.

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

getCurrency() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

The currency gathered from the GatewayTransactionResponse.getAmount()

getCurrency() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The currency gathered from PaymentTransaction.getAmount()

getCurrency() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

The currency gathered from the PaymentValidationRequest.getAmount()

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

Any customer information that relates to this transaction

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

getCustomerIpAddress() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The customer IP address that instigated this transaction

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

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

Returns the first PaymentGatewayCustomerService that matches the given PaymentGatewayType.

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

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

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

The timestamp when this transaction response was recorded

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

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)

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

The type of transaction failure (hard vs soft failure)

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).

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

The type of transaction failure

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

getField(String, String, String, Class<T>) - Method in class com.broadleafcommerce.paymentgateway.properties.DiscriminatedProperties

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

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

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 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

getFulfillmentTotal() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

The payment's total fulfillment cost

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

getGatewayMessage() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

Message from the gateway describing the result of the transaction.

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

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

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

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

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

The transaction id that is returned by the payment gateway.

getGatewayTransactionId() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The gateway-specific id for the transaction.

getGatewayTransactionId() - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The gateway-specific id for the transaction.

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

The executed transaction type, as described by the gateway.

getGatewayTransactionType() - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The type of this transaction, as described by the gateway.

getGatewayType() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

The gateway used to process this payment.

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.DefaultPassthroughTestingTransactionService

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.DefaultPaymentGatewayResourceProvider

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

Returns the first PaymentGatewayHostedService that matches the given PaymentGatewayType.

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

getId() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The id of this payment transaction.

getId() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

The id of this payment.

getId() - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The id of the Broadleaf transaction.

getIdentifier() - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionIdentifier

The transaction identifier value.

getIdentifierType() - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionIdentifier

Describes the type of transaction identifier.

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

getManagementState() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The state of this transaction - e.g.

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

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

The name of this payment.

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

Deprecated.

In favor of PaymentRequest.paymentOwnerDescription

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

Deprecated.

In favor of PaymentRequest.paymentOwnerType and PaymentRequest.paymentOwnerId.

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

Deprecated.

In favor of PaymentResponse.paymentOwnerType and PaymentResponse.paymentOwnerId.

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

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

getOwnerId() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

The id of the entity that owns this payment.

getOwnerType() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

Describes the owner of the payment.

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

getParentTransactionId() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The id of the parent PaymentTransaction.

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

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

The Payment Gateway Type that this transaction response represents

getPaymentGatewayWebhookHandlers() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider

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

The Payment ID that this transaction is associated with

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

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

The id of the related Broadleaf payment.

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

Map to capture any information about the payment method needed to perform gateway transactions.

getPaymentMethodProperties() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

Map to capture any information about the payment method needed to perform gateway transactions

getPaymentModificationService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider

getPaymentModificationService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayResourceProvider

Returns the implementation of PaymentGatewayPaymentModificationService for the specified gateway type.

getPaymentModificationServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider

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

A description of the payment owner associated with this transaction

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

A description of the payment owner associated with this transaction

getPaymentOwnerId() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

The ID of the owning entity that this transaction is associated with

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

The id of the entity that owns the payment.

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

The id of the entity that owns the payment.

getPaymentOwnerType() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

The type of the owning entity that this transaction is associated with

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

Describes the owner of the payment.

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

Describes the owner of the payment.

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

Deprecated.

in favor of PaymentResponse.getPaymentMethodProperties()

getPaymentToken(PaymentRequest) - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughTestingTransactionService

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

The PaymentType that this transaction is associated with

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.DefaultPaymentGatewayResourceProvider

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

Returns the first PaymentGatewayPaymentValidator that matches the given PaymentGatewayType.

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

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.

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

The string representation of the serialized response from the gateway.

getRawTransactionResults() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

The raw transaction response from the gateway; contains additional properties from the gateway to be processed and saved to the payment.

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.DefaultPaymentGatewayResourceProvider

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

Returns the first PaymentGatewayReportingService that matches the given PaymentGatewayType.

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

getRequestId() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The id used to represent the request that produced this transaction.

getRequestId() - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The id used to represent the request that produced this transaction.

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.DefaultPaymentGatewayResourceProvider

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

Returns the first PaymentGatewayRollbackService that matches the given PaymentGatewayType.

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

getSavedPaymentMethodService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider

getSavedPaymentMethodService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayResourceProvider

Returns the implementation of PaymentGatewaySavedPaymentMethodService for the specified gateway type or null.

getSavedPaymentMethodServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider

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.GatewayTransactionResponse

If shipping information is captured on the gateway, the shipping address associated with this transaction will be put here

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

getShouldSavePaymentToCustomer() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

Deprecated, for removal: This API element is subject to removal in a future version.

since 1.0.2, in favor of PaymentValidationRequest.shouldSavePaymentForFutureUse() to support owning user types other than a customer (i.e. account).

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

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

getSource() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The name of the system that initiated the transaction - e.g.

getSourceEntityId() - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The ID of the source entity associated with the transaction.

getSourceEntityType() - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The type of the source entity associated with the transaction.

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

getStatus() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The status of the transaction

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

Any information required to execute recurring billing

getSubtotal() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

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

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

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

The payment's total tax cost

getTenant() - Method in class com.broadleafcommerce.paymentgateway.properties.DiscriminatedProperties

getTenantId() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

The tenant id

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

The tenant id associated with the current request.

getTenantId() - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionIdentifier

The tenant id that the payment transaction belongs to.

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.

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

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

getThreeDSTransactionLookupServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider

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

getTransactionDetails(Map<String, String>, String, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGateway3DSTransactionLookupService

Returns the payment details.

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

The transaction reference that is passed to the payment gateway.

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.

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

The transaction id known by the payment gateway.

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

The transaction id known by the payment gateway.

getTransactionResponseService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider

getTransactionResponseService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayResourceProvider

Returns the first PaymentGatewayTransactionResponseService that matches the given PaymentGatewayType.

getTransactionResponseServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider

getTransactionResponseValidator(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider

getTransactionResponseValidator(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayResourceProvider

Returns the first PaymentGatewayTransactionResponseValidator that matches the given PaymentGatewayType.

getTransactionResponseValidators() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider

getTransactions() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

Transaction data representing each payment gateway interaction related to this payment.

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

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

Returns the first PaymentGatewayTransactionService that matches the given PaymentGatewayType.

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

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.GatewayTransactionResponse

The TransactionType that this transaction is associated with

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

The Transaction Type of the Payment that this response represents

getType() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The type of this transaction (authorize, capture, refund, etc.)

getType() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

The type of this payment like Credit Card or Gift Card.

getType() - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The type of this transaction (authorize, capture, refund, etc.)

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

getVersion() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The version of this payment transaction.

getVersion() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

The version of this payment.

getWebhookHandler(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider

getWebhookHandler(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayResourceProvider

Returns the first PaymentGatewayWebhookHandler that matches the given PaymentGatewayType.

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

GIFT_CARD - com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

GIFT_CARD_NUM - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

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

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

H

handleAVSoftDecline(PaymentRequest, TransactionType) - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughTestingTransactionService

handleCVSoftDecline(PaymentRequest, TransactionType) - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughTestingTransactionService

handleInsufficientFundsHardDecline(PaymentRequest, TransactionType) - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughTestingTransactionService

handleLostStolenHardDecline(PaymentRequest, TransactionType) - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughTestingTransactionService

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

HARD - com.broadleafcommerce.paymentgateway.domain.enums.PaymentDeclineType

hashCode() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

hashCode() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

hashCode() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

hashCode() - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionIdentifier

hashCode() - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

I

identifyParentTransactionReferenceIfExists(Map<String, Object>, Map<String, Object>) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransactionService

identifyTransactionTypeFromTransactionResults(Map<String, Object>, Map<String, Object>) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransactionService

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

INTERNAL_ERROR - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

There was an error in our preparation of the gateway interaction or in our interpretation/storing of the response.

INVALID_PAYMENT_METHOD - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

The provided payment method data is invalid.

INVALID_REQUEST - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

There was a failure to process the request because the request itself is invalid.

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

The exception is thrown when the parameters to fetch the payment details are invalid.

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

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

Exception denoting that the integration is insufficiently configured.

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

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

Exception denoting that a transaction's TransactionType is considered invalid for the gateway.

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

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

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

Declares whether the transaction was executed synchronously, or if the transaction results will be provided asynchronously.

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

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.

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

Determines whether a multi-use token should be created.

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

isIndeterminateResult() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

Tells if this transaction has an indeterminate result.

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

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

isSingleUsePaymentMethod() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

Whether or not the underlying payment method can only be used once.

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.

isTransactionReferenceId(String) - Static method in enum com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionIdentifierTypes

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.

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

J

JCB - com.broadleafcommerce.paymentgateway.domain.enums.CreditCardType

L

LAST_FOUR - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

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() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest

LineItem - Class in com.broadleafcommerce.paymentgateway.domain

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

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

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

lookupTransactionDetails(TransactionLookupRequest, String, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGateway3DSTransactionLookupService

Gathers transaction details from the payment gateway.

M

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

MASTERCARD - com.broadleafcommerce.paymentgateway.domain.enums.CreditCardType

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

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

modifyPaymentMethodProperties(Map<String, String>, String, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayPaymentModificationService

Modify the given paymentMethodProperties for alternative values used by the gateway.

MONEY_ORDER - com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

MULTI_USE_PAYMENT_METHODS - com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType

Whether payment methods (a.k.a tokens in some systems) can be reused to initiate a future line of transaction.

N

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

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

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

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

NAME_ON_ACCOUNT - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

NAME_ON_CARD - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

NETWORK_ERROR - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

There was an error in communicating with the payment gateway.

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

Deprecated.

In favor of PaymentRequest.paymentOwnerDescription

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

Deprecated.

In favor of PaymentRequest.paymentOwnerType and PaymentRequest.paymentOwnerId.

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

Deprecated.

In favor of PaymentResponse.paymentOwnerType and PaymentResponse.paymentOwnerId.

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

PARTIAL_CAPTURE - com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType

Whether this gateway allows capturing less than the full amount.

PARTIAL_REFUND - com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType

Similar to DefaultGatewayFeatureType.PARTIAL_CAPTURE but with refunds.

PARTIAL_REVERSE_AUTH - com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType

Similar to DefaultGatewayFeatureType.PARTIAL_CAPTURE but with reverse-authorizations.

PASSTHROUGH - com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentGatewayTypes

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

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

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

PAUSED - com.broadleafcommerce.paymentgateway.vendor.service.type.ServiceStatusType

PAYMENT_NAME - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

PAYMENT_TYPE - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

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) - Constructor for exception com.broadleafcommerce.paymentgateway.service.exception.PaymentException

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

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

PaymentGateway3DSTransactionLookupService - Interface in com.broadleafcommerce.paymentgateway.service

This service is responsible for interacting with the payment gateway to fetch the payment details.

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.

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.

PaymentGatewayHostedService - Interface in com.broadleafcommerce.paymentgateway.service

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

PaymentGatewayPaymentModificationService - Interface in com.broadleafcommerce.paymentgateway.service

This service is responsible for interacting with the payment gateway to modify a payment's paymentMethodProperties.

PaymentGatewayPaymentValidator - Interface in com.broadleafcommerce.paymentgateway.service

Validator meant to ensure that PaymentValidationRequest 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.

PaymentGatewayResolver - Interface in com.broadleafcommerce.paymentgateway.service

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

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

PaymentGatewayRollbackService - Interface in com.broadleafcommerce.paymentgateway.service

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

PaymentGatewaySavedPaymentMethodService - Interface in com.broadleafcommerce.paymentgateway.service

This service is responsible for interacting with the payment gateway for the saved payment methods.

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.

PaymentGatewayTransactionResponseService - Interface in com.broadleafcommerce.paymentgateway.service

This service is intended to record transactions from the payment gateway and build a PaymentResponse from the GatewayTransactionResponse.

PaymentGatewayTransactionResponseValidator - Interface in com.broadleafcommerce.paymentgateway.service

This interface provides an extension point for payment gateway implementations to add validation to the transaction confirmation service.

PaymentGatewayTransactionService - Interface in com.broadleafcommerce.paymentgateway.service

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

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

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

Identifies the payment gateway related to a given PaymentRequest or 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 payment gateway type in PaymentGatewayResourceProvider.

PaymentGatewayWebhookHandler - Interface in com.broadleafcommerce.paymentgateway.service

A gateway-specific interface to assist with the interpretation & processing of payment gateway webhook requests.

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.

paymentMethodProperties(Map<String, String>) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

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

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

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

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

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

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() - Constructor for class com.broadleafcommerce.paymentgateway.domain.PaymentResponse

PaymentResponse(PaymentType, PaymentGatewayType) - 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

Deprecated.

in favor of PaymentResponse.paymentMethodProperties(Map)

paymentTokenMatches(String, String) - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughTestingTransactionService

PaymentTransaction - Class in com.broadleafcommerce.paymentgateway.domain

Used to store individual transactions about a particular payment.

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

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

paymentType(PaymentType) - 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.

PaymentValidationRequest - Class in com.broadleafcommerce.paymentgateway.domain

This entity is designed to store payment methods associated to a Cart, the PaymentValidationRequest.getAmount() the user is to be charged via that payment method, and the history of attempted transactions (authorizations, charges, refunds, etc.) against that payment method for the owning Cart.

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

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

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

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

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

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

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

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

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

PROCESSING_FAILURE - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

The payment gateway failed to successfully process the transaction.

PURCHASE_ORDER - com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

Q

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

R

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

RECURRING_PAYMENTS - com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType

Whether the gateway supports recurring or subscription payments.

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.DefaultPassthroughTestingTransactionService

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.

REFUND - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes

Funds have been refunded/credited.

REQUEST_ID - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

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

REQUIRES_3DS_VERIFICATION - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

Additional verification is required from the customer for the gateway to successfully process the transaction

REQUIRES_ADDITIONAL_ACTION - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

Additional action is required for the transaction to be successfully processed

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

Resolves a PaymentGatewayType based on a WebRequest

RESPONSE_VALIDATION_FAILURE - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

There was an error when checking the validity of the response.

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

REVERSE_AUTH - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes

The reverse of an DefaultTransactionTypes.AUTHORIZE transaction.

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

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

SAVED_PAYMENTS - com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType

Whether the gateway supports saving customer payments for future use.

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.

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

The collection of related addresses that may include billing or shipping addresses

setAdjustmentsTotal(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

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

setAmount(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

The transaction amount that was processed by the gateway

setAmount(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The amount related to this transaction.

setAmount(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

The amount for which this payment is allotted.

setAmount(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The amount related to this transaction.

setApplication(Map<String, P>) - Method in class com.broadleafcommerce.paymentgateway.properties.DiscriminatedProperties

setApplicationId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

The application id

setAttributes(Map<String, String>) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

Map of specific attributes that have been gathered from the raw response.

setAttributes(Map<String, String>) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

General use map to capture any additional attributes needed for this PaymentValidationRequest

setAttributes(Map<String, String>) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

Map of additional attributes that can be used to identify the transaction.

setBillTo(Address<GatewayTransactionResponse>) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

The billing address associated with this transaction

setCustomer(GatewayCustomer<GatewayTransactionResponse>) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

Any customer information that relates to this transaction

setCustomerIpAddress(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The customer IP address that instigated this transaction

setDateRecorded(Instant) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The timestamp when this transaction response was recorded

setDateRecorded(Instant) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The timestamp when this transaction response was recorded

setDeclineType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The type of transaction failure (hard vs soft failure)

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.

setFailureType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The type of transaction failure

setFulfillmentTotal(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

The payment's total fulfillment cost

setGatewayMessage(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

Message from the gateway describing the result of the transaction.

setGatewayResponseCode(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

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

setGatewayTransactionId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The gateway-specific id for the transaction.

setGatewayTransactionId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The gateway-specific id for the transaction.

setGatewayTransactionType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The type of this transaction, as described by the gateway.

setGatewayType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

The gateway used to process this payment.

setId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The id of this payment transaction.

setId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

The id of this payment.

setId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The id of the Broadleaf transaction.

setIdentifier(String) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionIdentifier

The transaction identifier value.

setIdentifierType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionIdentifier

Describes the type of transaction identifier.

setIndeterminateResult(boolean) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

Tells if this transaction has an indeterminate result.

setManagementState(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The state of this transaction - e.g.

setName(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

The name of this payment.

setOwnerId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

The id of the entity that owns this payment.

setOwnerType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

Describes the owner of the payment.

setParentTransactionId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The id of the parent PaymentTransaction.

setPaymentGatewayWebhookHandlers(List<PaymentGatewayWebhookHandler>) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider

setPaymentId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

The Payment ID that this transaction is associated with

setPaymentId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The id of the related Broadleaf payment.

setPaymentMethodProperties(Map<String, String>) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

Map to capture any information about the payment method needed to perform gateway transactions

setPaymentModificationServices(List<PaymentGatewayPaymentModificationService>) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider

setPaymentOwnerId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

The ID of the owning entity that this transaction is associated with

setPaymentOwnerType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

The type of the owning entity that this transaction is associated with

setPaymentType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

The PaymentType that this transaction is associated with

setRawResponse(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The string representation of the serialized response from the gateway.

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

The raw transaction response from the gateway; contains additional properties from the gateway to be processed and saved to the payment.

setRequestId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The id used to represent the request that produced this transaction.

setRequestId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The id used to represent the request that produced this transaction.

setSavedPaymentMethodServices(List<PaymentGatewaySavedPaymentMethodService>) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider

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

setShipTo(Address<GatewayTransactionResponse>) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

If shipping information is captured on the gateway, the shipping address associated with this transaction will be put here

setShouldSavePaymentForFutureUse(boolean) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

Should the payment method be saved to the owning user.

setShouldSavePaymentToCustomer(boolean) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

Deprecated.

since 1.0.2, in favor of PaymentValidationRequest.shouldSavePaymentForFutureUse to support owning user types other than a customer (i.e. account).

setSingleUsePaymentMethod(boolean) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

Whether or not the underlying payment method can only be used once.

setSource(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The name of the system that initiated the transaction - e.g.

setSourceEntityId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The ID of the source entity associated with the transaction.

setSourceEntityType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The type of the source entity associated with the transaction.

setStatus(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The status of the transaction

setSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

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

setTaxTotal(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

The payment's total tax cost

setTenant(Map<String, P>) - Method in class com.broadleafcommerce.paymentgateway.properties.DiscriminatedProperties

setTenantId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

The tenant id

setTenantId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionIdentifier

The tenant id that the payment transaction belongs to.

setThreeDSecureVerificationUrl(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

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

setThreeDSTransactionLookupServices(List<PaymentGateway3DSTransactionLookupService>) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider

setTransactionReferenceId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

The transaction reference that is passed to the payment gateway.

setTransactionReferenceId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The transaction id known by the payment gateway.

setTransactionReferenceId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The transaction id known by the payment gateway.

setTransactions(List<PaymentTransaction>) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

Transaction data representing each payment gateway interaction related to this payment.

setTransactionType(TransactionType) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

The TransactionType that this transaction is associated with

setType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The type of this transaction (authorize, capture, refund, etc.)

setType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

The type of this payment like Credit Card or Gift Card.

setType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

The type of this transaction (authorize, capture, refund, etc.)

setVersion(Integer) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

The version of this payment transaction.

setVersion(Integer) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

The version of this payment.

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

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

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.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

shouldHandleRequest(HttpHeaders, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayWebhookHandler

Determines if the webhook request should be handled.

shouldSavePaymentForFutureUse() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

Should the payment method be saved to the owning user

SOFT - com.broadleafcommerce.paymentgateway.domain.enums.PaymentDeclineType

START - com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentLogEventTypes

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

STORE_CREDIT - com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

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

SUBSCRIPTION_ID - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

SUBSCRIPTION_TITLE - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

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

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

THIRD_PARTY_ACCOUNT - com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

Intended for payments like PayPal Express Checkout.

THREE_D_SECURE - com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType

Whether the payment gateway supports 3D Secure fraud detection.

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

TOKEN - com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType

toString() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse

toString() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction

toString() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest

toString() - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionIdentifier

toString() - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionLookupRequest

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

TRANSACTION_REFERENCE_ID - com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionIdentifierTypes

The transaction identifier communicated via PaymentRequest.getTransactionReferenceId() and PaymentResponse.getTransactionReferenceId().

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

TransactionIdentifier - Class in com.broadleafcommerce.paymentgateway.domain

Describes the identifier of a transaction.

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

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

The TransactionIdentifierType is used to represent the types of transaction identifiers communicated via PaymentGatewayWebhookHandler#getTransactionIdentifier(HttpHeaders, Object).

TransactionLookupRequest - Class in com.broadleafcommerce.paymentgateway.domain

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

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

The exception is thrown if a transaction cannot be found.

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

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

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

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

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

The exception is thrown if transaction results cannot be identified.

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

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

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

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

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.

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

UP - com.broadleafcommerce.paymentgateway.vendor.service.type.ServiceStatusType

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

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

V

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

validate(HttpHeaders, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayWebhookHandler

Validates that the webhook request came from the gateway & that it wasn't tampered with.

validatePayment(PaymentValidationRequest, String, String) - Method in class com.broadleafcommerce.paymentgateway.service.passthrough.DefaultPassthroughPaymentValidator

validatePayment(PaymentValidationRequest, String, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayPaymentValidator

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

validateRequestParams(Map<String, String>) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGateway3DSTransactionLookupService

Validates the request parameters

validateTransactionResponse(GatewayTransactionResponse) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransactionResponseValidator

Validates that the transaction results are valid and were sent by the payment gateway.

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.DefaultTransactionIdentifierTypes

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.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.DefaultTransactionIdentifierTypes

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.vendor.service.type.ServiceStatusType

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

VISA - com.broadleafcommerce.paymentgateway.domain.enums.CreditCardType

W

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

The exception is thrown when the processing of the payment webhook failed.

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

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

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

Exception denoting that a webhook request is invalid.

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

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

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

WIRE - com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes

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