Broadleaf Microservices
  • v1.0.0-latest-prod

Broadleaf PayPal Checkout Integration

Table of Contents


This integration leverages PayPal’s standard checkout button and the PayPal REST API to execute payment transactions against a payment method from the customer’s PayPal account.

Transaction Types

This module supports the following transaction types

  • Authorize

  • Capture

  • Authorize and Capture (i.e. immediate capture)

  • Refund

  • Reverse Authorization

For more details on executing these types of transactions, see the Executing Transactions section.


This gateway supports the following features:

  • Partial Capture

  • Partial Refund

  • Multi-Use Payment Methods

PayPal offers saved payment functionality to customers who have PayPal accounts. These are presented to the customer by PayPal on the frontend and don’t have a backend integration at this time.
PayPal offers a "buy now, pay later" feature to customers on the frontend. It does not require a backend integration for customers to use.
Authorized transactions last for 29 days and may be captured anytime up to then. After 3 days, the "hold" placed on the funds is released. To add the hold again, perform a new authorization on the current authorized transaction. This will produce a new transaction than may be captured. This process will be repeated until the 29th day from the initial authorization.