All Classes and Interfaces
Class
Description
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.
An enumeration of credit card types.
Simple interface for returning a
PaymentRequest based on the current customer in the
system (like something on threadlocal).
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.
Defines common features that gateways implement.
The default set of
ManualFraudReviewResultTypes that we
expect to encounter with payment gateway interactionsPassthrough Transaction Service intended to be used for Testing Purposes.
The default set of payment gateway types.
The default set of log event types for payment interactions.
This represents types of payments that can be applied to a cart.
The default statuses for the saved payment method.
The default set of
SupportedWebhookNotificationTypes
that we can support in PaymentTransactionServices.The default set of
transactionFailureTypes that we expect to
encounter with payment gateway interactionsThe TransactionType is used to represent the types of operations/transactions that could occur
against a single payment.
The exception is thrown when an error occurred during token exchanging.
The exception is thrown when an error occurred while exchanging the digital wallet token.
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.
The exception is thrown when an error occurred during fetching transaction results.
A DTO that contains information needed to save transaction data from a payment gateway.
The exception is thrown when the parameters to fetch the payment details are invalid.
Exception denoting that the integration is insufficiently configured.
Exception denoting that a transaction's
TransactionType is considered invalid for the
gateway.Exception denoting that a
Payment representation is considered invalid.Exception denoting that a webhook request is invalid.
The ManualFraudReviewResultType is used to describe the outcome of a manual fraud review of a
transaction.
Object describing the next action for the payment transaction process.
An enumeration of next action types.
Constants to be used for a payment callback request, such as a redirect back to Broadleaf from a
3DS verification or HPP interaction.
Exception denoting that no security token was found for the payment callback.
Utility class to create, validate, and manage payment callback tokens.
The DTO is used to build the notification that can be sent to the customer.
When a payment gateway declines a payment, this value indicates whether it is a "soft"
(insufficient funds) or "hard" (stolen card) decline.
Deprecated.
This API is intended to define the specific configuration parameters that this gateway
implementation currently supports.
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.
Certain Payment Integrations allow you to use a Hosted Solution, such as PayPal Express and
SagePay Form.
This service is responsible for interacting with the payment gateway to modify a payment's
paymentMethodProperties.
Validator meant to ensure that
PaymentValidationRequest objects are sufficiently
configured, allowing transactions to be executed via the related
PaymentGatewayTransactionService implementation.
This API provides the ability to get the status of a Transaction after it has been submitted to
the Gateway.
This represents the main service bus for retrieving payment gateway service implementations to
execute service calls programmatically.
This API allows each module to provide its own implementation for rollback.
This service is responsible for interacting with the payment gateway for the saved payment
methods.
A gateway-specific interface to assist with the interpretation & processing of payment gateway
webhook requests.
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.
This service is responsible for interacting with the payment gateway to fetch the payment
details.
This service is intended to record transactions from the payment gateway and build a
PaymentResponse from the GatewayTransactionResponse.This interface provides an extension point for payment gateway implementations to add validation
to the transaction confirmation service.
This is an interface that provides the basic functions to create billable credit card
transactions
Identifies the payment gateway related to a given
PaymentRequest or
PaymentResponse.This API is intended to identify the related
PaymentGatewayType so that the resource can
be easily identified by the payment gateway type in PaymentGatewayResourceProvider.A gateway-specific interface to assist with the interpretation & processing of payment gateway
webhook requests.
The Payment information that is used to add, update or remove the payment method properties,
using the provided payment type and additional attributes.
Common keys used for the
PaymentInfo.getAttributes() mapIdentifies the log event type for a payment interaction.
The exception is thrown when an error occurred during the modification of the payment method
properties.
A DTO that is comprised of all the information that is sent to a Payment Gateway to complete a
transaction.
The DTO object that represents the response coming back from any call to the Gateway.
Used to store individual transactions about a particular payment.
This represents types of payments that can be applied to a cart.
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.The information that is used to build the customer notification for the saved payment method.
Some payment gateways require extra time or verification steps to finish creating the saved
payment method.
Represents the statuses of the saved payment method.
An extendible enumeration of service status types.
The SupportedWebhookNotificationType is used to describe a type of webhook notification that is
supported by a
PaymentGatewayWebhookHandler implementation.The TransactionFailureType is used to identify the category of failure that was encountered while
processing a payment gateway transaction
Describes the identifier of a transaction.
The TransactionIdentifierType is used to represent the types of transaction identifiers
communicated via
PaymentGatewayWebhookHandler#getTransactionIdentifier(HttpHeaders, Object).The exception is thrown if a transaction cannot be found.
The exception is thrown if transaction results cannot be identified.
The TransactionType is used to represent the types of operations/transactions that could occur
against a single payment.
The exception is thrown when the processing of the payment webhook failed.
The exception thrown when the validation of the webhook request fails.
PaymentGatewayTransactionLookupService