Broadleaf Microservices
  • v1.0.0-latest-prod

Payment Transaction Release Notes for 1.1.11-GA

Requirements

  • JDK 11 is required for Broadleaf release trains 1.7.0-GA, and beyond.

  • JDK 17 is supported for Broadleaf release trains 1.8.1-GA, and beyond.

New Features & Notable Changes

  • Introduced the ability to declare fee & included tax totals on Payments, PaymentSummaries, PaymentTransactions, & various transaction request/response payloads.

    • The intention of this to allow PaymentTransactionServices to accept & persist these amount detail fields to serve as a parallel representation to what is known/understood by the calling service.

    • The payment & transaction total remains the only required amount field.

    • It’s 100% up to the calling service to determine the values for these optional fields.

    • PaymentTransactionServices does nothing with these values other than persist them to the Payment or PaymentTransactions. In the case of a request that must span multiple transactions (e.g. refund $20 across a $5 capture and a $15 capture for the same payment), then the amount details will be prorated to the individual transactions.

    • The changes with this also update the CartOps & OrderOps plumbing that leads to the creation of a TransactionExecutionRequest, just to provide the ability to declare these amount details. This work stops at the point of actually determining & declaring these values in the TransactionExecutionRequest.

  • Introduced TransactionSummary concept that provides a better view into the transactions that have been executed for an owning entity’s (e.g. a cart’s) payments.

    • As opposed to the PaymentSummary that describes the transaction amount totals for a given Payment & describes what’s possible for a Payment, the TransactionSummary describes what has historically been done against the Payment.

  • Introduced the new webhook endpoint POST /webhooks/saved-payment-method/{gatewayType} that is used to update the saved payment method if it requires some additional verification steps before it can be used. This is a part of the support of the Stripe ACH saved payment method creation.

  • Introduced support for hosted payment page interactions for Checkout.com KNET

Schema Changes

ALTER TABLE BLC_SAVED_PAYMENT_METHOD ADD STATUS VARCHAR(60) DEFAULT 'AVAILABLE_TO_USE';

ALTER TABLE BLC_SAVED_PAYMENT_METHOD ADD GATEWAY_REF_ID VARCHAR(500);

ALTER TABLE BLC_SAVED_PAYMENT_METHOD ADD NEXT_ACTION VARCHAR(65535);