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