Broadleaf Microservices
  • v1.0.0-latest-prod

Payment Provider

Table of Contents

Overview

There are two external providers (PaymentProvider and PaymentTransactionExecutionProvider) for interfacing with Payment Transaction Services for operations around payment and payment transactions. The default implementation facilitates HTTP requests against the Payment Transaction Services endpoints.

Configuration

ExternalPaymentProperties defines the properties used to configure ExternalPaymentProvider and ExternalPaymentTransactionExecutionProvider, which are the default implementations. These include:

  • broadleaf.cartoperation.paymentprovider.url

    • The base url for an external payment transaction service.

  • broadleaf.cartoperation.paymentprovider.payments-uri **The context path for CRUD operation on payments. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.payment-transactions-uri **The URI path for basic CRUD operations on payment transactions. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.lock-payments-uri

    • The context path for locking multiple payments. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.lock-and-retrieve-payments-uri

    • The URI path for locking multiple payments and includes their PaymentSummaries in the response. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.unlock-payments-uri

    • The context path for unlocking multiple payments. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.authorize-uri

    • The context path for executing an authorize transaction. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.authorize-and-capture-uri

    • The context path for executing an authorize and capture transaction. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.finalize-payments-uri

    • The URI path for finalizing payments after checkout. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.block-customer-mutability-for-payments-uri

    • The URI path for blocking customer mutability for payments in checkout that require finalization. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.block-customer-mutability-for-payment-finalization-uri

    • The URI path for removing customer mutability blocks for payments in checkout. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.remove-customer-mutability-block-for-payment-finalization-uri

    • The URI path for removing customer mutability blocks for payments in checkout. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.transfer-customer-payments-to-csr-uri

    • The URI path for transferring a customer payment to a CSR. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.transfer-csr-payments-to-customer-uri

    • The URI path for transferring a CSR payment to a customer. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.claim-transactions-for-request-uri

    • The URI path to reset payment transaction reversal state. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.lookup-3ds-transaction-result-uri

    • The URI path to lookup 3DS payment transaction results from the gateway. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.lookup-external-transaction-result-uri

    • The URI path to lookup external payment transaction results from the gateway. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.handle-external-transaction-result-uri

    • The URI path to lookup external payment transaction results & record them to the relevant transaction. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.validate-payment-callback-token-uri

    • The URI path to validate the payment callback request based on the token. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.read-saved-payment-methods-uri

    • The URI path to read the saved payment methods. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.transform-payment-fulfillment-request-uri

    • The URI path to transform a fulfillment callback request. This is appended to the url property.

  • broadleaf.cartoperation.paymentprovider.build-payment-fulfillment-response-uri

    • The URI path to build a fulfillment callback response for the payment gateway. This is appended to the url property.

Example of building request from properties
UriComponentsBuilder.fromHttpUrl(properties.getUrl())
        .path(properties.getPaymentsUri())
        .toUriString())