Skip to main content

Install the PayPal Checkout Flow

The PayPal Checkout Flow extension uses Bold Checkout to add PayPal checkout options for your Adobe Commerce store. Using the built-in Adobe Commerce checkout and PayPal Checkout Flow together allows merchants to choose which payment processor an order should go to. Customers also have the option of checking out with their payment information or their PayPal account.

Screenshot of an example store with a PayPal and built-in checkout buttons.

Supported features

Supported features include:

Constraints

  • caution

    Bold currently supports one Bold-hosted Checkout flow in use at a time. Activating the PayPal Checkout Flow disables any currently enabled Bold-hosted Checkout flows.

  • The PayPal Checkout Flow can only be used with PayPal Commerce Platform (PPCP) as the payment gateway.
  • The PayPal Checkout Flow extension does not support the following features:
    • Advanced credit/debit card configuration
    • Buy Online, Pickup In Store (BOPIS) functionality
    • Third-party plugins
    • Loyalty programs and store credits
    • Gift card payments
    • Shipping to multiple addresses

Prerequisites

  1. Install and configure Bold Checkout on your Adobe Commerce store using the installation guide that corresponds to your architectural needs. For more information, refer to the Overview.
  2. Configure PayPal Commerce Platform as your store's payment gateway. Instructions can be found in the Help Center.

Check Bold Checkout Extension version

The Adobe Commerce Bold Checkout extension version must be >= 1.1.23.

There are two ways to check the extension version: using a Composer command, or through the Adobe Commerce admin page post-installation.

Run the following command to return your extension version:
composer show bold-commerce/module-checkout | grep versions

Update versions < 1.1.23

If your version is earlier than 1.1.23, run the following Composer command:

composer require bold-commerce/module-checkout:">=1.1.23"

Install the extension on your store

Run the following commands to install and enable the extension:

  1. Add the extension's Composer package:

    composer require bold-commerce/module-checkout-flow-paypal
  2. Enable the extension:

    php bin/magento module:enable Bold_CheckoutFlowPaypal
  3. Compile and deploy the extension:

    php bin/magento setup:upgrade
    php bin/magento setup:di:compile
    php bin/magento setup:static-content:deploy -f
  4. Flush the Magento cache before continuing:

    php bin/magento cache:flush

If your PayPal business account admin requires a phone number from customers, you must also require a phone number in the Bold Checkout and Adobe Commerce admins. Check if your PayPal business account requires phone numbers with the following instructions:

  1. In your PayPal business account admin, navigate to Account Settings. Click Website Payments.
  2. Next to Website Preferences, click Update.
  3. View the Contact telephone number setting.

If the Contact telephone number setting is On (required field), set your Bold Checkout and Adobe store admins to require customer phone numbers at checkout.

Bold Checkout:

  1. In the Bold Checkout admin, navigate to Settings > General Settings.
  2. In the Checkout Process section, toggle the Phone Number setting on.
  3. Click Save.

Adobe Commerce:

  1. In the Adobe Commerce admin, navigate to Stores > Configuration.
  2. In the Scope drop-down menu at the top of the page, select Main Website.
    note

    This drop-down is titled Store View in Adobe Commerce versions earlier than 2.4.

  3. In the left-hand menu of the Configuration page, navigate to Customers > Customer Configuration.
  4. Expand the Name and Address Options section.
  5. Set the Show Telephone field to Required.
  6. Click Save Config.

Usage and configuration

The next sections explain how to enable, configure, and disable the PayPal Checkout Flow in the Adobe Commerce admin.

Enable the PayPal Checkout Flow

After installing the extension, enable the PayPal Checkout Flow from your Adobe Commerce admin.

  1. In the Adobe Commerce admin, navigate to Stores > Configuration.
  2. In the Scope drop-down menu at the top of the page, select Main Website.
    note

    This drop-down is titled Store View in Adobe Commerce versions earlier than 2.4.

  3. In the left-hand menu of the Configuration page, navigate to Sales > Checkout.
  4. Expand the Bold Checkout PayPal Integration section. Screenshot of the expanded Bold Checkout PayPal Integration section in the Adobe Commerce Admin.
  5. If the Is PayPal Checkout Flow Enabled? field is set to No, click the Enable button.
  6. Click OK in the confirmation pop-up. Screenshot of a popup in front of Bold Checkout PayPal Integration section. The popup asks for permission to continue.
  7. Once the page reloads, Is PayPal Checkout Flow Enabled? is set to PayPal Checkout Flow is enabled. The flow is successfully enabled for your store. Screenshot of the expanded Bold Checkout PayPal Integration section in the Adobe Commerce Admin. The flow is enabled.
info

The PayPal Checkout Flow uses the "Dual" setting in the Bold Checkout Type field. Enabling the PayPal Checkout Flow in the Adobe Commerce admin automatically changes the store's Bold Checkout Type to "Dual".

(Optional) Configure "Buy now with PayPal" on product pages

The extension allows merchants to add a "buy now" button to products based on product type. (Read more about product types on the Adobe Commerce Experience League.)

Screenshot of a product page with &quot;Add to Cart&quot; and &quot;Buy now with PayPal&quot; options.

By default, this functionality is enabled but not configured. To configure Buy now with PayPal for products, you must select which products show the button.

  1. In the Bold Checkout PayPal Integration section, ensure Enable for Product Page is set to Yes.
  2. Ensure Use Default is not selected for Enable for Product Types.
  3. Select the desired type of product to show the Buy now with PayPal button.
  4. Click Save Config.

To disabled Buy now with PayPal for products, you must set the Enable for Product Page field to No.

  1. In the Bold Checkout PayPal Integration section, ensure Use Default is not selected for Enable for Product Page.
  2. In the Enable for Product Page field, select No in the drop down menu.
  3. Click Save Config.

Verify PayPal Checkout Flow

Now that the PayPal Checkout Flow is enabled, verify the extension works by checking out in your store.

  1. Navigate to your Adobe Commerce store.
  2. Add a product to your cart.
  3. Click the cart icon to expand checkout options. Two options display: Proceed with Checkout and Checkout with PayPal. Screenshot of a cart preview in an Adobe Commerce Store. Both &quot;Proceed with Checkout&quot; and &quot;Checkout with PayPal&quot; are available.
  4. Click the Checkout with PayPal button.
  5. Checkout with any of the available options. Screenshot of a PayPal options in an Adobe Commerce store checkout. &quot;PayPal&quot; and &quot;Pay Later&quot; are available.

Disable the PayPal Checkout Flow

The Disable button allows you to deactivate the PayPal Checkout Flow.

  1. In the Adobe Commerce admin, navigate to Stores > Configuration.
  2. In the Scope drop-down menu at the top of the page, select Main Website.
    note

    This drop-down is titled Store View in Adobe Commerce versions earlier than 2.4.

  3. In the left-hand menu of the Configuration page, navigate to Sales > Checkout.
  4. Expand the Bold Checkout PayPal Integration section. Screenshot of the expanded Bold Checkout PayPal Integration section in the Adobe Commerce Admin. The flow is enabled.
  5. If the Is PayPal Checkout Flow Enabled? field is set to Yes, click the Disable button.
  6. Once the page reloads, Is PayPal Checkout Flow Enabled? is set to No. Screenshot of the expanded Bold Checkout PayPal Integration section in the Adobe Commerce Admin. The flow is disabled.
info

The Bold Checkout Type is still set to "Dual" after disabling the PayPal Checkout Flow. Remember to change your Bold Checkout Type to previous settings if necessary.