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.lock-payments-uri

    • The context path for locking multiple payments. 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.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.

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