Index

A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType
 
ACCOUNT_TYPE - Enum constant in enum class 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
 
ACH - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
ACH_VERIFICATION_FORM - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.NextActionType
The next action is to display the ACH form
ACTION_FAILED - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSavedPaymentMethodStatuses
The action has failed or expired.
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
 
addPaymentCallbackTokenToPaymentMethodPropertyUrls(PaymentInfo, Set<String>, String, String) - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
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 - Enum constant in enum class 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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
An error that occurs when too many requests hit the gateway's API too quickly
APPLE_PAY - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
applicationId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest
 
APPROVED - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultManualFraudReviewResultTypes
The transaction was approved via a manual review after it was flagged by fraud checks.
AUTH_CODE - Enum constant in enum class 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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes
Funds have been authorized for capture.
AUTHORIZE_AND_CAPTURE - Enum constant in enum class 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.
AVAILABLE_TO_USE - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSavedPaymentMethodStatuses
The saved payment method is available to use for checkout.
AWAITING_ASYNC_RESULTS - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSavedPaymentMethodStatuses
The saved payment method is created, but we're expecting an asynchronous notification from the gateway declaring if the payment method is valid or invalid.
awaitingAsyncResults(boolean) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
 

B

BANK_ACCOUNT - Enum constant in enum class 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
 
BNPL - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
buildCustomerNotification(SavedPaymentMethodInfo, String, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewaySavedPaymentMethodService
This method is used to build the notification that should be sent to the customer when the saved payment method is created.
buildFailedWebhookResponse(Exception) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewaySavedPaymentMethodWebhookHandler
Builds & returns a ResponseEntity meant to communicate to the gateway that the webhook request was unsuccessfully processed.
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.PaymentGatewaySavedPaymentMethodWebhookHandler
Builds & returns a ResponseEntity meant to communicate to the gateway that the webhook request was successfully processed.
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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType
Whether the gateway supports a buy-now-pay-later feature.

C

CANCELED - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
The customer canceled the payment/transaction.
canEqual(Object) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse
 
canEqual(Object) - Method in class com.broadleafcommerce.paymentgateway.domain.NextAction
 
canEqual(Object) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentCustomerNotification
 
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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes
Funds have been charged/submitted/debited from the customer and payment is complete.
CARD_TYPE - Enum constant in enum class 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 - Enum constant in enum class 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 - Enum constant in enum class 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
 
composeCustomerFullName() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer
 
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
 
containsCallbackUrl(Map<String, String>, Set<String>) - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
convertToPaymentResponse(HttpHeaders, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayWebhookHandler
Deprecated, for removal: This API element is subject to removal in a future version.
convertToPaymentResponse(HttpHeaders, String, Map<String, String>) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayWebhookHandler
Builds & returns a pair of TransactionIdentifier & PaymentResponse based on the contents of the webhook request.
convertWebhookRequest(HttpHeaders, String, Map<String, String>) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewaySavedPaymentMethodWebhookHandler
Builds & returns a SavedPaymentMethodSetupResult based on the content 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 - Enum constant in enum class 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 Class 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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
CUSTOMER_PAYMENT - Enum constant in enum class 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
 
customerNotification(PaymentCustomerNotification) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
 
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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType
 
declineType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
 
DefaultGatewayFeatureType - Enum Class in com.broadleafcommerce.paymentgateway.domain.enums
Defines common features that gateways implement.
defaultHandler - Variable in class com.broadleafcommerce.paymentgateway.vendor.service.monitor.ServiceMonitor
 
DefaultManualFraudReviewResultTypes - Enum Class in com.broadleafcommerce.paymentgateway.domain.enums
The default set of ManualFraudReviewResultTypes that we expect to encounter with payment gateway interactions
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 Class in com.broadleafcommerce.paymentgateway.domain.enums
The default set of payment gateway types.
DefaultPaymentLogEventTypes - Enum Class 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 Class in com.broadleafcommerce.paymentgateway.domain.enums
This represents types of payments that can be applied to a cart.
DefaultSavedPaymentMethodStatuses - Enum Class in com.broadleafcommerce.paymentgateway.domain.enums
The default statuses for the saved payment method.
DefaultSupportedWebhookNotificationTypes - Enum Class in com.broadleafcommerce.paymentgateway.domain.enums
The default set of SupportedWebhookNotificationTypes that we can support in PaymentTransactionServices.
DefaultTransactionFailureTypes - Enum Class in com.broadleafcommerce.paymentgateway.domain.enums
The default set of transactionFailureTypes that we expect to encounter with payment gateway interactions
DefaultTransactionIdentifierTypes - Enum Class in com.broadleafcommerce.paymentgateway.domain.enums
 
DefaultTransactionTypes - Enum Class 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
 
deleteGatewaySavedPaymentMethod(PaymentInfo, String, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewaySavedPaymentMethodService
The handler is used to modify, add or remove the payment method properties before deleting the saved payment method.
description(String) - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem
 
DETACHED_CREDIT - Enum constant in enum class 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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.CreditCardType
 
DISCOVER - Enum constant in enum class 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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.vendor.service.type.ServiceStatusType
 

E

ELECTRONIC_CHECK - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
email(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer
 
EMAIL - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType
 
emailAddress(String) - Method in class com.broadleafcommerce.paymentgateway.domain.Address
 
encodePaymentCallbackToken(String, String, String) - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
ENDTYPE - Static variable in class com.broadleafcommerce.paymentgateway.util.UnmaskRange
 
ENROUTE - Enum constant in enum class 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.NextAction
 
equals(Object) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentCustomerNotification
 
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
Deprecated, for removal: This API element is subject to removal in a future version.
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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType
 
EXP_MONTH - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType
 
EXP_YEAR - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType
 
expDate(String) - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard
 
EXPIRED - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
The payment/transaction didn't receive a successfully paid transaction after timeout.
expMonth(String) - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard
 
expYear(String) - Method in class com.broadleafcommerce.paymentgateway.domain.CreditCard
 
EXTERNAL_PAYMENT_ENTRY_FORM - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.NextActionType
The next action is to display an external payment entry form

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
 
FetchTransactionResultsException(String, Throwable) - Constructor for exception com.broadleafcommerce.paymentgateway.service.exception.FetchTransactionResultsException
 
findDetailsByTransaction(PaymentRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayReportingService
 
FINISHED - Enum constant in enum class 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
 
flaggedForManualReview(Boolean) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
 
FORCED_REVERSE_AUTH_WITH_PARTIAL_CAPTURE - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType
Declares that when a partial capture is executed for the gateway, they ALWAYS automatically execute a reverse-authorization for the remaining authorized amount.
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
 
fullName(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer
 

G

GATEWAY_CONFIGURATION_ERROR - Enum constant in enum class 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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
The provided payment gateway credentials are not valid
GATEWAY_ERROR - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
There was an unexpected error with the payment gateway itself.
GATEWAY_TRANSACTION_ID - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionIdentifierTypes
The transaction identifier returned from the gateway.
GATEWAY_TYPE - Enum constant in enum class 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
 
generatePaymentCallbackToken(PaymentInfo, String, String, boolean) - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
get3DSTransactionLookupService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider
Deprecated.
get3DSTransactionLookupService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayResourceProvider
getAccountNumber() - Method in class com.broadleafcommerce.paymentgateway.domain.CustomerCredit
 
getActionType() - Method in class com.broadleafcommerce.paymentgateway.domain.NextAction
The type of action that must be taken.
getAdditionalAttributes() - Method in class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodSetupResult
Contains the additional information about the webhook event.
getAdditionalData() - Method in class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodInfo
Any additional data needed to build the notification.
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.
getAllowedCharacters(String, String, String) - Method in class com.broadleafcommerce.paymentgateway.properties.PaymentCallbackTokenProperties
 
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.
getApplicationId() - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionIdentifier
The application id that the payment transaction belongs to.
getAttributes() - Method in class com.broadleafcommerce.paymentgateway.domain.NextAction
Map holding any additional attributes not matching any defined properties.
getAttributes() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentInfo
General use map to capture any additional attributes.
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.
getBaseUri(String) - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
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
getCallbackUrlKeys() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayPaymentModificationService
Provides the set of PaymentInfo.getPaymentMethodProperties() map keys for any properties that declare a callback url used to redirect back to a Broadleaf context following an interaction like 3DS verification or a HPP interaction.
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.PaymentInfo
The currency unit used for the payment.
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.
getCustomerEmail() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentCustomerNotification
The customer email address.
getCustomerFullName() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentCustomerNotification
The customer full name.
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
getCustomerNotification() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
The notification that should be sent to the customer.
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
 
getData() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentCustomerNotification
Any data that is used to populate the HTML template for this notification.
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
 
getDeserializedCreationDate(String, String, String) - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
getEmail() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer
 
getEmailAddress() - Method in class com.broadleafcommerce.paymentgateway.domain.Address
 
getErrorMessage() - Method in class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodSetupResult
Returns the error message if creating the saved payment method is failed.
getEventId(HttpHeaders, String, Map<String, String>) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayWebhookHandler
Returns the event id for this request.
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
 
getFeesTotal() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest
The total fees related to the transaction PaymentValidationRequest.amount Note: Only the PaymentValidationRequest.amount is required, but if this value is included, then the PaymentValidationRequest.subtotal, PaymentValidationRequest.fulfillmentTotal, PaymentValidationRequest.adjustmentsTotal, PaymentValidationRequest.taxTotal, & PaymentValidationRequest.includedTaxTotal should be included also.
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
 
getFlaggedForManualReview() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
Indicates that the payment transaction has been flagged for manual review via fraud checks.
getFrequency() - Method in class com.broadleafcommerce.paymentgateway.domain.Subscription
How often the customer will be charged
getFriendlyName() - Method in enum class com.broadleafcommerce.paymentgateway.domain.enums.CreditCardType
 
getFriendlyName() - Method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentLogEventTypes
 
getFriendlyName() - Method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
getFriendlyName() - Method in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType
 
getFriendlyName() - Method in enum class 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 class 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
 
getFullName() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer
 
getGatewayMessage() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction
Message from the gateway describing the result of the transaction.
getGatewayReferenceId() - Method in class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodInfo
The ID of the object known by the payment gateway that was created to set up the saved payment method.
getGatewayReferenceId() - Method in class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodSetupResult
Returns the saved payment method id known by the payment gateway.
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.PaymentInfo
The payment gateway used to process this payment.
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.
getIncludedTaxTotal() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest
The amount of taxes that are included in the subtotal (VAT).
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
 
getLength(String, String, String) - Method in class com.broadleafcommerce.paymentgateway.properties.PaymentCallbackTokenProperties
 
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.
getManualReviewResult() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
Describes the outcome of the manual review of a transaction after it was flagged by fraud checks.
getManualReviewResultReason() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
Describes the reason for approving/rejecting a transaction during a manual fraud review.
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.
getNextAction() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
 
getNextAction() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction
 
getNumberOfInstallments() - Method in class com.broadleafcommerce.paymentgateway.domain.Subscription
The number of times that the customer will be charged
getObjectMapper() - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
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.
getOwningUserId() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest
The id of the owning user that owns this payment.
getOwningUserType() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest
Describes the owning user type 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.
getPaymentCallbackTokenEncoder() - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
getPaymentCallbackTokenProperties() - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
getPaymentGatewayConfigurations() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider
 
getPaymentGatewaySavedPaymentMethodWebhookHandler() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider
 
getPaymentGatewayStatus() - Method in class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodSetupResult
Returns the payment gateway status.
getPaymentGatewayType() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentCustomerNotification
The payment gateway type.
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.PaymentCustomerNotification
The payment id.
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.PaymentInfo
Map to capture any information about the payment method needed to perform gateway transactions
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
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.PaymentCustomerNotification
The payment type.
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
getPaymentType() - Method in class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodInfo
The payment type for the saved payment method.
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.
getRecommendedSavedPaymentMethodStatus() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
Assuming that a saved payment method was used for the interaction, this field provides a recommended SavedPaymentMethodStatus based on the results of the interaction.
getRecurringAmount() - Method in class com.broadleafcommerce.paymentgateway.domain.Subscription
The amount that must be paid for each billing cycle
getRedirectUrl() - Method in class com.broadleafcommerce.paymentgateway.domain.NextAction
The gateway-provided url that can redirect to the next action the customer must take.
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
 
getSavedPaymentMethodWebhookHandler(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider
 
getSavedPaymentMethodWebhookHandler(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayResourceProvider
Returns the first PaymentGatewaySavedPaymentMethodWebhookHandler that matches the given PaymentGatewayType.
getSecureTokenQueryParam(PaymentInfo, String, String, String) - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
getSerializedCreationDate(Instant, String, String) - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
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, fees, and shipping.
getSuccessful() - Method in class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodSetupResult
Whether the saved payment method is created successfully.
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.
getSupportedWebhookNotificationTypes() - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayWebhookHandler
Declares the list of supported webhook notification types for the implementation.
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.SavedPaymentMethodSetupResult
The tenant id that the saved payment method belongs to.
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
 
getThreeDSecureVerificationUrl() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction
 
getThreeDSTransactionLookupServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider
 
getTokenChars(String, String, String) - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
getTokenDuration(String, String, String) - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
getTokenLength(String, String, String) - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
getTotal() - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem
 
getTransactionDetails(Map<String, String>, String, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGateway3DSTransactionLookupService
Deprecated.
Returns the payment details.
getTransactionDetails(Map<String, String>, String, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransactionLookupService
Returns the payment details.
getTransactionLookupService(String) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider
 
getTransactionLookupService(String) - Method in interface com.broadleafcommerce.paymentgateway.service.provider.PaymentGatewayResourceProvider
Returns the implementation of PaymentGatewayTransactionLookupService for the specified gateway type.
getTransactionLookupServices() - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider
 
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
getTtl(String, String, String) - Method in class com.broadleafcommerce.paymentgateway.properties.PaymentCallbackTokenProperties
 
getType() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentCustomerNotification
The notification type.
getType() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentInfo
The type of this payment like Credit Card or Gift Card.
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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
GIFT_CARD_NUM - Enum constant in enum class 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
 
GOOGLE_PAY - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 

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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentDeclineType
 
hashCode() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse
 
hashCode() - Method in class com.broadleafcommerce.paymentgateway.domain.NextAction
 
hashCode() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentCustomerNotification
 
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
 
HOSTED_PAYMENT_PAGE_TRANSACTION_RESULTS - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSupportedWebhookNotificationTypes
Webhook notifications that communicate the results of transactions triggered by interactions with the gateway's hosted payment page.

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 - Enum constant in enum class 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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSavedPaymentMethodStatuses
It's been determined that the provided payment method is invalid & cannot be used.
INVALID_PAYMENT_METHOD - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
The provided payment method data is invalid.
INVALID_REQUEST - Enum constant in enum class 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
 
InvalidWebhookRequestException - Exception in com.broadleafcommerce.paymentgateway.service.exception
Exception denoting that a webhook request is invalid.
InvalidWebhookRequestException() - Constructor for exception com.broadleafcommerce.paymentgateway.service.exception.InvalidWebhookRequestException
 
InvalidWebhookRequestException(String) - Constructor for exception com.broadleafcommerce.paymentgateway.service.exception.InvalidWebhookRequestException
 
IP_ADDRESS - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentInfoAttributes
The calling user's IP address
is3DSTransactionResults(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSupportedWebhookNotificationTypes
 
is3DSVerificationFailure(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
 
isACH(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
isACHVerificationForm(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.NextActionType
 
isActionFailed(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSavedPaymentMethodStatuses
 
isAPIRateLimitError(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
 
isApplePay(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
isApproved(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultManualFraudReviewResultTypes
 
isAuthorize(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes
 
isAuthorizeAndCapture(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes
 
isAvailableToUse(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSavedPaymentMethodStatuses
 
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.
isAwaitingAsyncResults(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSavedPaymentMethodStatuses
 
isBankAccount(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
isBNPL(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
isCanceled(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
 
isCapture(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes
 
isCheck(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
isCOD(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
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.
isCreditCard(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
isCustomerCredit(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
isCustomerPayment(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
isDetachedCredit(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes
 
isElectronicCheck(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
isExpired(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
 
isExternalPaymentEntryForm(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.NextActionType
 
isFinalPayment() - Method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
Deprecated.
isFinalPayment() - Method in interface com.broadleafcommerce.paymentgateway.domain.enums.PaymentType
 
isGatewayConfigurationError(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
 
isGatewayCredentialsError(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
 
isGatewayError(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
 
isGatewayTransactionId(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionIdentifierTypes
 
isGiftCard(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
isGooglePay(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
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 class com.broadleafcommerce.paymentgateway.domain.enums.PaymentDeclineType
 
isHostedPaymentPageTransactionResults(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSupportedWebhookNotificationTypes
 
isIndeterminateResult() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction
Tells if this transaction has an indeterminate result.
isInternalError(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
 
isInvalidModificationRequest() - Method in exception com.broadleafcommerce.paymentgateway.service.exception.PaymentMethodPropertiesModificationException
Used to declare if the request contains an insufficient data to make the payment method properties modification.
isInvalidPaymentMethod(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSavedPaymentMethodStatuses
 
isInvalidPaymentMethod(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
 
isInvalidRequest(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
 
isKNET(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
isManualFraudReviewResults(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSupportedWebhookNotificationTypes
 
isMoneyOrder(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
isNetworkError(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
 
isPayPal(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
isProcessingFailure(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
 
isPurchaseOrder(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
isRefund(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes
 
isRejected(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultManualFraudReviewResultTypes
 
isRequires3DSVerification(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
 
isRequiresAction(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSavedPaymentMethodStatuses
 
isRequiresAdditionalAction(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
 
isRequiresExternalInteraction(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
 
isRequiresHostedPaymentPageInteraction(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
 
isResponseValidationFailure(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
 
isReverseAuth(String) - Static method in enum class 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 class com.broadleafcommerce.paymentgateway.domain.enums.PaymentDeclineType
 
isStoreCredit(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
isSubsequentTransactionResults(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSupportedWebhookNotificationTypes
 
isSuccessful() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
Whether or not the transaction on the gateway was successful.
isThirdPartyAccount(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
isThreeDSVerificationForm(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.NextActionType
 
isTokenExpired(String, PaymentInfo, String, String) - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
isTransactionReferenceId(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionIdentifierTypes
 
isTransactionResults(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSupportedWebhookNotificationTypes
 
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.
isWire(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
itemTotal(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.LineItem
 

J

JCB - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.CreditCardType
 

K

KNET - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
Alternative Payment Methods

L

LAST_FOUR - Enum constant in enum class 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
Deprecated.
Gathers transaction details from the payment gateway.
lookupTransactionDetails(TransactionLookupRequest, String, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransactionLookupService
Gathers transaction details from the payment gateway.

M

MANUAL_FRAUD_REVIEW_RESULTS - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSupportedWebhookNotificationTypes
Webhook notifications that communicate the results of a manual fraud review.
ManualFraudReviewResultType - Interface in com.broadleafcommerce.paymentgateway.domain.enums
The ManualFraudReviewResultType is used to describe the outcome of a manual fraud review of a transaction.
manualReviewResult(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
 
manualReviewResultReason(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
 
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 - Enum constant in enum class 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(PaymentInfo, String, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayPaymentModificationService
Modify the given PaymentInfo.getPaymentMethodProperties() for alternative values used by the gateway.
modifyPaymentMethodProperties(Map<String, String>, String, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayPaymentModificationService
Deprecated, for removal: This API element is subject to removal in a future version.
modifyPaymentMethodPropertiesForCreate(PaymentInfo, String, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewaySavedPaymentMethodService
The handler is used to modify, add or remove the payment method properties before creating the saved payment method.
modifyPaymentMethodPropertiesForUpdate(PaymentInfo, PaymentInfo, String, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewaySavedPaymentMethodService
The handler is used to modify, add or remove the payment method properties before updating the saved payment method.
MONEY_ORDER - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
MULTI_USE_PAYMENT_METHODS - Enum constant in enum class 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.ManualFraudReviewResultType
 
name() - Method in interface com.broadleafcommerce.paymentgateway.domain.enums.PaymentGatewayType
 
name() - Method in interface com.broadleafcommerce.paymentgateway.domain.enums.PaymentType
 
name() - Method in interface com.broadleafcommerce.paymentgateway.domain.enums.SavedPaymentMethodStatus
 
name() - Method in interface com.broadleafcommerce.paymentgateway.domain.enums.SupportedWebhookNotificationType
 
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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType
 
NAME_ON_CARD - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType
 
NETWORK_ERROR - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
There was an error in communicating with the payment gateway.
nextAction(NextAction) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
 
NextAction - Class in com.broadleafcommerce.paymentgateway.domain
Object describing the next action for the payment transaction process.
NextAction() - Constructor for class com.broadleafcommerce.paymentgateway.domain.NextAction
 
NextActionType - Enum Class in com.broadleafcommerce.paymentgateway.domain.enums
An enumeration of next action types.
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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType
Whether this gateway allows capturing less than the full amount.
PARTIAL_REFUND - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType
Similar to DefaultGatewayFeatureType.PARTIAL_CAPTURE but with refunds.
PARTIAL_REVERSE_AUTH - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType
Similar to DefaultGatewayFeatureType.PARTIAL_CAPTURE but with reverse-authorizations.
PASSTHROUGH - Enum constant in enum class 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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.vendor.service.type.ServiceStatusType
 
PAYMENT_CALLBACK_TOKEN - Static variable in class com.broadleafcommerce.paymentgateway.constants.PaymentCallbackConstants
 
PAYMENT_CALLBACK_TOKEN_CREATE_DATE - Static variable in class com.broadleafcommerce.paymentgateway.constants.PaymentCallbackConstants
 
PAYMENT_CALLBACK_TOKEN_ID - Static variable in class com.broadleafcommerce.paymentgateway.constants.PaymentCallbackConstants
 
PAYMENT_CALLBACK_TOKEN_PARAM_PREFIX - Static variable in class com.broadleafcommerce.paymentgateway.constants.PaymentCallbackConstants
 
PAYMENT_NAME - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType
 
PAYMENT_TYPE - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType
 
PaymentAdditionalFieldType - Enum Class in com.broadleafcommerce.paymentgateway.domain.enums
 
PaymentCallbackConstants - Class in com.broadleafcommerce.paymentgateway.constants
Constants to be used for a payment callback request, such as a redirect back to Broadleaf from a 3DS verification or HPP interaction.
PaymentCallbackConstants() - Constructor for class com.broadleafcommerce.paymentgateway.constants.PaymentCallbackConstants
 
PaymentCallbackSecurityConfiguration() - Constructor for class com.broadleafcommerce.paymentgateway.util.autoconfigure.PaymentGatewayCommonUtilAutoConfiguration.PaymentCallbackSecurityConfiguration
 
PaymentCallbackSecurityTokenNotFoundException - Exception in com.broadleafcommerce.paymentgateway.service.exception
Exception denoting that no security token was found for the payment callback.
PaymentCallbackSecurityTokenNotFoundException(String) - Constructor for exception com.broadleafcommerce.paymentgateway.service.exception.PaymentCallbackSecurityTokenNotFoundException
 
paymentCallbackSecurityTokenUtil(PasswordEncoder, PaymentCallbackTokenProperties, ObjectMapper) - Method in class com.broadleafcommerce.paymentgateway.util.autoconfigure.PaymentGatewayCommonUtilAutoConfiguration.PaymentCallbackSecurityConfiguration
 
PaymentCallbackSecurityTokenUtil - Class in com.broadleafcommerce.paymentgateway.util
Utility class to create, validate, and manage payment callback tokens.
PaymentCallbackSecurityTokenUtil(PasswordEncoder, PaymentCallbackTokenProperties, ObjectMapper) - Constructor for class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
paymentCallbackTokenEncoder() - Method in class com.broadleafcommerce.paymentgateway.util.autoconfigure.PaymentGatewayCommonUtilAutoConfiguration.PaymentCallbackSecurityConfiguration
 
PaymentCallbackTokenProperties - Class in com.broadleafcommerce.paymentgateway.properties
 
PaymentCallbackTokenProperties() - Constructor for class com.broadleafcommerce.paymentgateway.properties.PaymentCallbackTokenProperties
 
PaymentCustomerNotification - Class in com.broadleafcommerce.paymentgateway.domain
The DTO is used to build the notification that can be sent to the customer.
PaymentCustomerNotification() - Constructor for class com.broadleafcommerce.paymentgateway.domain.PaymentCustomerNotification
 
PaymentDeclineType - Enum Class 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
PaymentGatewayCommonUtilAutoConfiguration - Class in com.broadleafcommerce.paymentgateway.util.autoconfigure
 
PaymentGatewayCommonUtilAutoConfiguration() - Constructor for class com.broadleafcommerce.paymentgateway.util.autoconfigure.PaymentGatewayCommonUtilAutoConfiguration
 
PaymentGatewayCommonUtilAutoConfiguration.PaymentCallbackSecurityConfiguration - Class in com.broadleafcommerce.paymentgateway.util.autoconfigure
 
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.
PaymentGatewaySavedPaymentMethodWebhookHandler - Interface in com.broadleafcommerce.paymentgateway.service
A gateway-specific interface to assist with the interpretation & processing of payment gateway webhook requests.
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.
PaymentGatewayTransactionLookupService - Interface in com.broadleafcommerce.paymentgateway.service
This service is responsible for interacting with the payment gateway to fetch the payment details.
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
 
PaymentInfo - Class in com.broadleafcommerce.paymentgateway.domain
The Payment information that is used to add, update or remove the payment method properties, using the provided payment type and additional attributes.
PaymentInfo() - Constructor for class com.broadleafcommerce.paymentgateway.domain.PaymentInfo
 
PaymentInfoAttributes - Enum Class in com.broadleafcommerce.paymentgateway.domain.enums
Common keys used for the PaymentInfo.getAttributes() map
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
 
PaymentMethodPropertiesModificationException - Exception in com.broadleafcommerce.paymentgateway.service.exception
The exception is thrown when an error occurred during the modification of the payment method properties.
PaymentMethodPropertiesModificationException(String) - Constructor for exception com.broadleafcommerce.paymentgateway.service.exception.PaymentMethodPropertiesModificationException
 
PaymentMethodPropertiesModificationException(String, boolean) - Constructor for exception com.broadleafcommerce.paymentgateway.service.exception.PaymentMethodPropertiesModificationException
 
PaymentMethodPropertiesModificationException(String, Throwable) - Constructor for exception com.broadleafcommerce.paymentgateway.service.exception.PaymentMethodPropertiesModificationException
 
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
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
 
PAYPAL - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
Digital Wallet Types
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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
The payment gateway failed to successfully process the transaction.
PURCHASE_ORDER - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 

Q

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

R

RANDOM - Static variable in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
rawResponse(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
 
recommendedSavedPaymentMethodStatus(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
 
RECURRING_PAYMENTS - Enum constant in enum class 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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes
Funds have been refunded/credited.
REJECTED - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultManualFraudReviewResultTypes
The transaction was rejected via a manual review after it was flagged by fraud checks.
REQUEST_ID - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType
 
requestHostedEndpoint(PaymentRequest, boolean) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayHostedService
 
REQUIRES_3DS_VERIFICATION - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
Additional verification is required from the customer for the gateway to successfully process the transaction
REQUIRES_ACTION - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSavedPaymentMethodStatuses
The saved payment method requires an additional action to be executed.
REQUIRES_ADDITIONAL_ACTION - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
Additional action is required for the transaction to be successfully processed
REQUIRES_EXTERNAL_INTERACTION - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
This transaction requires additional interaction from the customer from an external source.
REQUIRES_HOSTED_PAYMENT_PAGE_INTERACTION - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
Requires interaction with the gateway's hosted payment page.
resolvePaymentGateway(WebRequest) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayResolver
Resolves a PaymentGatewayType based on a WebRequest
RESPONSE_VALIDATION_FAILURE - Enum constant in enum class 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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes
The reverse of an DefaultTransactionTypes.AUTHORIZE transaction.
REVERSE_AUTH_REMAINDER - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType
Declares that this gateway's reverse authorize transaction can only be applied to the full remaining non-captured amount.
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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType
Whether the gateway supports saving customer payments for future use.
SavedPaymentMethodInfo - Class in com.broadleafcommerce.paymentgateway.domain
The information that is used to build the customer notification for the saved payment method.
SavedPaymentMethodInfo() - Constructor for class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodInfo
 
SavedPaymentMethodSetupResult - Class in com.broadleafcommerce.paymentgateway.domain
Some payment gateways require extra time or verification steps to finish creating the saved payment method.
SavedPaymentMethodSetupResult() - Constructor for class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodSetupResult
 
SavedPaymentMethodStatus - Interface in com.broadleafcommerce.paymentgateway.domain.enums
Represents the statuses of the saved payment method.
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 Class in com.broadleafcommerce.paymentgateway.vendor.service.type
An extendible enumeration of service status types.
setActionType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.NextAction
The type of action that must be taken.
setAdditionalAttributes(Map<String, String>) - Method in class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodSetupResult
Contains the additional information about the webhook event.
setAdditionalData(Map<String, Object>) - Method in class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodInfo
Any additional data needed to build the notification.
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.
setAllowedCharacters(Map<String, String>) - Method in class com.broadleafcommerce.paymentgateway.properties.PaymentCallbackTokenProperties
The character set to use when generating payment callback tokens identified by PaymentGatewayType.name().
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
setApplicationId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.TransactionIdentifier
The application id that the payment transaction belongs to.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.paymentgateway.domain.NextAction
Map holding any additional attributes not matching any defined properties.
setAttributes(Map<String, String>) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentInfo
General use map to capture any additional attributes.
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
setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentInfo
The currency unit used for the payment.
setCustomer(GatewayCustomer<GatewayTransactionResponse>) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse
Any customer information that relates to this transaction
setCustomerEmail(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentCustomerNotification
The customer email address.
setCustomerFullName(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentCustomerNotification
The customer full name.
setCustomerIpAddress(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction
The customer IP address that instigated this transaction
setData(Object) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentCustomerNotification
Any data that is used to populate the HTML template for this notification.
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
 
setErrorMessage(String) - Method in class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodSetupResult
Returns the error message if creating the saved payment method is failed.
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
setFeesTotal(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest
The total fees related to the transaction PaymentValidationRequest.amount Note: Only the PaymentValidationRequest.amount is required, but if this value is included, then the PaymentValidationRequest.subtotal, PaymentValidationRequest.fulfillmentTotal, PaymentValidationRequest.adjustmentsTotal, PaymentValidationRequest.taxTotal, & PaymentValidationRequest.includedTaxTotal should be included also.
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.
setGatewayReferenceId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodInfo
The ID of the object known by the payment gateway that was created to set up the saved payment method.
setGatewayReferenceId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodSetupResult
Returns the saved payment method id known by the payment gateway.
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.PaymentInfo
The payment gateway used to process this payment.
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.
setIncludedTaxTotal(MonetaryAmount) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest
The amount of taxes that are included in the subtotal (VAT).
setIndeterminateResult(boolean) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction
Tells if this transaction has an indeterminate result.
setLength(Map<String, Integer>) - Method in class com.broadleafcommerce.paymentgateway.properties.PaymentCallbackTokenProperties
The length of a generated payment callback token identified by PaymentGatewayType.name().
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.
setNextAction(NextAction) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction
The next step required for the payment gateway to continue processing 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.
setOwningUserId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest
The id of the owning user that owns this payment.
setOwningUserType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest
Describes the owning user type of the payment.
setParentTransactionId(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentTransaction
The id of the parent PaymentTransaction.
setPaymentGatewaySavedPaymentMethodWebhookHandler(List<PaymentGatewaySavedPaymentMethodWebhookHandler>) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider
 
setPaymentGatewayStatus(String) - Method in class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodSetupResult
Returns the payment gateway status.
setPaymentGatewayType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentCustomerNotification
The payment gateway type.
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.PaymentCustomerNotification
The payment id.
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.PaymentInfo
Map to capture any information about the payment method needed to perform gateway transactions
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
setPaymentType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentCustomerNotification
The payment type.
setPaymentType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodInfo
The payment type for the saved payment method.
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.
setRedirectUrl(String) - Method in class com.broadleafcommerce.paymentgateway.domain.NextAction
The gateway-provided url that can redirect to the next action the customer must take.
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, fees, and shipping.
setSuccessful(Boolean) - Method in class com.broadleafcommerce.paymentgateway.domain.SavedPaymentMethodSetupResult
Whether the saved payment method is created successfully.
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.SavedPaymentMethodSetupResult
The tenant id that the saved payment method belongs to.
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
Deprecated.
in favor of PaymentTransaction.nextAction
setThreeDSTransactionLookupServices(List<PaymentGateway3DSTransactionLookupService>) - Method in class com.broadleafcommerce.paymentgateway.service.provider.DefaultPaymentGatewayResourceProvider
 
setTransactionLookupServices(List<PaymentGatewayTransactionLookupService>) - 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
setTtl(Map<String, Duration>) - Method in class com.broadleafcommerce.paymentgateway.properties.PaymentCallbackTokenProperties
The duration in which a payment callback token is valid identified by PaymentGatewayType.name().
setType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentCustomerNotification
The notification type.
setType(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentInfo
The type of this payment like Credit Card or Gift Card.
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
Deprecated, for removal: This API element is subject to removal in a future version.
shouldHandleRequest(HttpHeaders, String, Map<String, String>) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewaySavedPaymentMethodWebhookHandler
Determines if the webhook request should be handled.
shouldHandleRequest(HttpHeaders, String, Map<String, 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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentDeclineType
 
START - Enum constant in enum class 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 - Enum constant in enum class 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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType
 
SUBSCRIPTION_TITLE - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType
 
subscriptionPopulated() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentRequest
 
subscriptionPopulated() - Method in class com.broadleafcommerce.paymentgateway.domain.Subscription
 
SUBSEQUENT_TRANSACTION_RESULTS - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSupportedWebhookNotificationTypes
Webhook notifications that communicate the results of transactions that we're NOT aware of - i.e.
successful(boolean) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
 
SupportedWebhookNotificationType - Interface in com.broadleafcommerce.paymentgateway.domain.enums
The SupportedWebhookNotificationType is used to describe a type of webhook notification that is supported by a PaymentGatewayWebhookHandler implementation.
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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
Intended for payments like PayPal Express Checkout.
THREE_D_SECURE - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType
Whether the payment gateway supports 3D Secure fraud detection.
THREE_D_SECURE_TRANSACTION_RESULTS - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSupportedWebhookNotificationTypes
Webhook notifications that communicate the results of transactions triggered by 3DS interactions.
THREE_D_SECURE_VERIFICATION_FAILURE - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
The required 3DS verification failed & the customer is not authorized to use the payment method.
THREE_DS_VERIFICATION_FORM - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.NextActionType
The next action is to display the 3D Secure form
threeDSecureVerificationUrl(String) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
 
TOKEN - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType
 
tokenMatches(String, String) - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
toString() - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayTransactionResponse
 
toString() - Method in class com.broadleafcommerce.paymentgateway.domain.NextAction
 
toString() - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentCustomerNotification
 
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 - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionIdentifierTypes
TRANSACTION_RESULTS - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSupportedWebhookNotificationTypes
Webhook notifications that communicate the results of transactions that we're aware of - i.e.
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 - Enum constant in enum class 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
 
updateUrlsToIncludePaymentCallbackTokenParam(PaymentInfo, String, Set<String>, Map<String, String>, String, String, String) - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
USER_AGENT - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentInfoAttributes
The calling user's browser user agent

V

valid(boolean) - Method in class com.broadleafcommerce.paymentgateway.domain.PaymentResponse
 
validate(HttpHeaders, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayWebhookHandler
Deprecated, for removal: This API element is subject to removal in a future version.
validate(HttpHeaders, String, Map<String, String>) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewaySavedPaymentMethodWebhookHandler
Validates that the webhook request came from the gateway & that it wasn't tampered with.
validate(HttpHeaders, String, Map<String, 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
Deprecated.
Validates the request parameters
validateRequestParams(Map<String, String>) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransactionLookupService
validateRequestParams(Map<String, String>, String, String) - Method in interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTransactionLookupService
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 class com.broadleafcommerce.paymentgateway.domain.enums.CreditCardType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultManualFraudReviewResultTypes
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentGatewayTypes
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentLogEventTypes
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSavedPaymentMethodStatuses
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSupportedWebhookNotificationTypes
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionIdentifierTypes
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.NextActionType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentDeclineType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentInfoAttributes
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.paymentgateway.vendor.service.type.ServiceStatusType
Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.CreditCardType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultGatewayFeatureType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultManualFraudReviewResultTypes
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentGatewayTypes
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentLogEventTypes
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSavedPaymentMethodStatuses
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultSupportedWebhookNotificationTypes
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionIdentifierTypes
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionTypes
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.NextActionType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentAdditionalFieldType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentDeclineType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.paymentgateway.domain.enums.PaymentInfoAttributes
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.paymentgateway.vendor.service.type.ServiceStatusType
Returns an array containing the constants of this enum class, in the order they are declared.
verifyPaymentCallbackSecurityToken(PaymentInfo, String, String, String) - Method in class com.broadleafcommerce.paymentgateway.util.PaymentCallbackSecurityTokenUtil
 
VISA - Enum constant in enum class 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
The exception thrown when the validation of the webhook request fails.
WebhookValidationException() - Constructor for exception com.broadleafcommerce.paymentgateway.service.exception.WebhookValidationException
 
WebhookValidationException(String) - Constructor for exception com.broadleafcommerce.paymentgateway.service.exception.WebhookValidationException
 
WebhookValidationException(String, Throwable) - Constructor for exception com.broadleafcommerce.paymentgateway.service.exception.WebhookValidationException
 
website(String) - Method in class com.broadleafcommerce.paymentgateway.domain.GatewayCustomer
 
WIRE - Enum constant in enum class com.broadleafcommerce.paymentgateway.domain.enums.DefaultPaymentTypes
 
A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form