Serialized Form (Broadleaf Payment Gateway Common Domain and Common Concepts 1.4.0-GA API)

Package com.broadleafcommerce.paymentgateway.domain
- Class com.broadleafcommerce.paymentgateway.domain.PaymentRequest extends Object implements Serializable
  - Serialized Fields
    - customer
```
GatewayCustomer<T> customer
```
      Any customer information that relates to this transaction
    - shipTo
```
Address<T> shipTo
```
      If shipping information is captured on the gateway, the values sent back will be put here
    - billTo
```
Address<T> billTo
```
      The billing address associated with this transaction
    - creditCard
```
CreditCard<T> creditCard
```
      For sale/authorize transactions, this will be the Credit Card object that was charged. This data is useful for showing on an order confirmation screen.
    - subscription
```
Subscription<T> subscription
```
      Any information required to execute recurring billing
    - giftCards
```
List<E> giftCards
```
      Any gift cards that have been processed. This data is useful for showing on an order confirmation screen
    - customerCredits
```
List<E> customerCredits
```
      Any customer credit accounts that have been processed. This data is useful for showing on an order confirmation screen
    - orderId
```
String orderId
```
      The Order ID that this transaction is associated with
    - paymentId
```
String paymentId
```
      The Payment ID that this transaction is associated with
    - sourceType
```
String sourceType
```
      Describes the origination of the payment. For example, the payment could have originated with a cart or a subscription, therefore this value might be CART or SUBSCRIPTION.
    - sourceId
```
String sourceId
```
      The id of the entity that caused this payment to be created. For example, this may be a cart id, or a subscription billing cycle id.
    - orderDescription
```
String orderDescription
```
      A description of the order associated with this transaction
    - lineItems
```
List<E> lineItems
```
      The items associated to the transaction's related order
    - paymentType
```
PaymentType paymentType
```
      The Type of Payment that this transaction response represents
    - gatewayRequestType
```
PaymentGatewayRequestType gatewayRequestType
```
      Additional information about the request that can be used by the gateway implementation to inform/direct portions of its functionality
    - transactionReferenceId
```
String transactionReferenceId
```
      The transaction reference that is passed to the payment gateway. This reference can be used to link the request to the gateway's record of the transaction in the case that the calling application does not receive a response from the gateway.
    - orderSubtotal
```
javax.money.MonetaryAmount orderSubtotal
```
      The order's total usually excluding adjustments, tax, and shipping.
    - adjustmentsTotal
```
javax.money.MonetaryAmount adjustmentsTotal
```
      The order's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.
    - shippingTotal
```
javax.money.MonetaryAmount shippingTotal
```
      The order's total shipping cost
    - taxTotal
```
javax.money.MonetaryAmount taxTotal
```
      The order's total tax cost
    - transactionTotal
```
javax.money.MonetaryAmount transactionTotal
```
      The order's total cost including tax & shipping charges
    - completeCheckoutOnCallback
```
boolean completeCheckoutOnCallback
```
      Sets whether or not this module should complete checkout on callback. In most Credit Card gateway implementation, this should be set to 'TRUE' and should not be configurable as the gateway expects it to tbe the final step in the checkout process.
      
      In gateways where it does not expect to be the last step in the checkout process, for example BLC Gift Card Module, PayPal Express Checkout, etc... The callback from the gateway can be configured whether or not to complete checkout.
    - siteBaseUrl
```
String siteBaseUrl
```
      The base url of the site that is making this payment request. This value will most commonly be used to help define a "return url" or "cancel url" that is used by the payment gateway to communicate information back to our server. This is most applicable in a multi-tenant context where the site context may vary (www.site1.com vs www.site2.com), but the relative return path (/payment-gateway/return) and cancel path (/payment-gateway/cancel) remains the same.
    - additionalFields
```
Map<K,V> additionalFields
```
      Any extra properties needed to define the requested transaction
- Class com.broadleafcommerce.paymentgateway.domain.PaymentResponse extends Object implements Serializable
  - Serialized Fields
    - customer
```
GatewayCustomer<T> customer
```
      Any customer information that relates to this transaction
    - shipTo
```
Address<T> shipTo
```
      If shipping information is captured on the gateway, the values sent back will be put here
    - billTo
```
Address<T> billTo
```
      The billing address associated with this transaction
    - creditCard
```
CreditCard<T> creditCard
```
      for sale/authorize transactions, this will be the Credit Card object that was charged. This data is useful for showing on an order confirmation screen.
    - giftCards
```
List<E> giftCards
```
      Any gift cards that have been processed. This data is useful for showing on an order confirmation screen
    - customerCredits
```
List<E> customerCredits
```
      Any customer credit accounts that have been processed. This data is useful for showing on an order confirmation screen
    - paymentGatewayType
```
PaymentGatewayType paymentGatewayType
```
      The Payment Gateway Type that this transaction response represents
    - paymentType
```
PaymentType paymentType
```
      The Type of Payment that this transaction response represents
    - transactionType
```
TransactionType transactionType
```
      The Transaction Type of the Payment that this response represents
    - transactionReferenceId
```
String transactionReferenceId
```
      The transaction reference that is passed to the payment gateway. This reference can be used to link the request to the gateway's record of the transaction in the case that the calling application does not receive a response from the gateway.
    - orderId
```
String orderId
```
      The Order ID that this transaction is associated with
    - paymentId
```
String paymentId
```
      The Payment ID that this transaction is associated with
    - amount
```
javax.money.MonetaryAmount amount
```
    - paymentToken
```
String paymentToken
```
      If this is a Tokenization request, this will hold the token sent back from the gateway
    - message
```
String message
```
      Message describing the result of the transaction
    - gatewayResponseCode
```
String gatewayResponseCode
```
      The response code provided by the payment gateway which may represent a success or failure
    - threeDSecureVerificationUrl
```
String threeDSecureVerificationUrl
```
      The gateway-provided url where the customer must verify that they are in fact the owner of the payment method. The customer is typically redirected to this location, but the page can also be rendered within an iframe if you'd like.
    - failureType
```
String failureType
```
      The type of transaction failure (TransactionFailureType).
    - declineType
```
String declineType
```
      The type of transaction decline (hard vs soft decline)
    - dateRecorded
```
Instant dateRecorded
```
      The timestamp when this transaction response was recorded
    - successful
```
boolean successful
```
      Whether or not the transaction on the gateway was successful. This should be provided by the gateway alone.
    - valid
```
boolean valid
```
      Whether or not this response was tampered with. This used to verify that the response that was received on the endpoint (which is intended to only be invoked from the payment gateway) actually came from the gateway and was not otherwise maliciously invoked by a 3rd-party.
    - completeCheckoutOnCallback
```
boolean completeCheckoutOnCallback
```
      Sets whether or not this module should complete checkout on callback. In most Credit Card gateway implementation, this should be set to 'TRUE' and should not be configurable as the gateway expects it to tbe the final step in the checkout process.
      
      In gateways where it does not expect to be the last step in the checkout process, for example BLC Gift Card Module, PayPal Express Checkout, etc... The callback from the gateway can be configured whether or not to complete checkout.
    - rawResponse
```
String rawResponse
```
      A string representation of the response that came from the gateway. This should be a string serialization of PaymentResponse.responseMap.
    - responseMap
```
Map<K,V> responseMap
```
      A more convenient representation of PaymentResponse.rawResponse to hold the response from the gateway.
Package com.broadleafcommerce.paymentgateway.domain.enums
Package com.broadleafcommerce.paymentgateway.service.exception
- Class com.broadleafcommerce.paymentgateway.service.exception.InvalidPaymentConfigurationException extends RuntimeException implements Serializable
- Class com.broadleafcommerce.paymentgateway.service.exception.PaymentException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L

Serialized Form

Package com.broadleafcommerce.paymentgateway.domain

Class com.broadleafcommerce.paymentgateway.domain.PaymentRequest extends Object implements Serializable

Serialized Fields

customer

shipTo

billTo

creditCard

subscription

giftCards

customerCredits

orderId

paymentId

sourceType

sourceId

orderDescription

lineItems

paymentType

gatewayRequestType

transactionReferenceId

orderSubtotal

adjustmentsTotal

shippingTotal

taxTotal

transactionTotal

completeCheckoutOnCallback

siteBaseUrl

additionalFields

Class com.broadleafcommerce.paymentgateway.domain.PaymentResponse extends Object implements Serializable

Serialized Fields

customer

shipTo

billTo

creditCard

giftCards

customerCredits

paymentGatewayType

paymentType

transactionType

transactionReferenceId

orderId

paymentId

amount

paymentToken

message

gatewayResponseCode

threeDSecureVerificationUrl

failureType

declineType

dateRecorded

successful

valid

completeCheckoutOnCallback

rawResponse

responseMap

Package com.broadleafcommerce.paymentgateway.domain.enums

Package com.broadleafcommerce.paymentgateway.service.exception

Class com.broadleafcommerce.paymentgateway.service.exception.InvalidPaymentConfigurationException extends RuntimeException implements Serializable

Class com.broadleafcommerce.paymentgateway.service.exception.PaymentException extends RuntimeException implements Serializable