Skip to main content

Use Payment Booster with an Adobe Commerce store

Payment Booster enables you to take advantage of Bold Checkout's payment solution, which increases security, reduces complexity, and provides built-in support for payment providers such as PayPal.

Using Payment Booster, you can retain the entirety of your current checkout experience, and use Bold to add additional payment options to your checkout.

In the following screenshot, the store utilizes the Payment Booster feature in order to show a "Pay with PayPal or Credit Card" option in the checkout experience:

Screenshot of Payment Booster feature

Prerequisites

Before you connect your Adobe Commerce store with Bold Checkout, ensure you have the following:

caution

Local development stores MUST use a port-forwarding service, such as ngrok, Cloudflare Tunnel, or OpenVPN in order to communicate with Bold Checkout.

Configure security settings

Your store's security settings may prevent Bold from making calls to your store. Use the following sections to ensure Bold can communicate properly and securely with your store and Adobe Commerce.

Configure firewall settings

Many merchants have firewalls in place that restrict incoming and outgoing network traffic, allowing only a predefined set of IP addresses. The nature of a platform connector requires Bold to make calls to your server. For Bold's integrations to function, Bold domains must be able to make requests to your application.

To ensure proper operation, you must configure your firewall settings to allow requests from the following domains or IP addresses:

Calls from Bold to your platform connector come from one of the following domains:
  • https://api.boldcommerce.com
  • https://checkout.boldcommerce.com
  • https://adobe-commerce-connector.boldapps.net

Configure User-Agent settings

Each call from Bold to your store is accompanied by a User-Agent header with a value of Bold-API. If your security system filters traffic based on headers, ensure that calls marked with User-Agent=Bold-API are permitted.

Set up Bold Checkout

Use the following sections to set up Bold Checkout.

Create an account in Bold Account Center

To create an account and connect your store in Bold Account Center, complete the following steps.

  1. On the Bold Account Center login page, click Create account. Create an Account Screenshot
  2. Complete the Name, Organization, Email, and Password fields. Click Next.
    note

    In this case, Organization usually refers to your company's name. This value is used to identify the stores associated with your account.

  3. Bold sends you an email to verify your email address. Verify email screen screenshot
    1. Find the message in your inbox and click Verify email. You will be directed back to Bold Account Center.
  4. Enroll in multi-factor authentication.
    note

    Bold requires you to enroll in multi-factor authentication in order to access the Bold Account Center. You can use an authenticator that either scans a QR code or that requires manually entering a code.

    MFA registration screenshot
    1. If you do not have one already, download an authenticator app (such as Google Authenticator, Microsoft Authenticator, 1Password, Authy, Duo, or others).
    2. In your authenticator app, scan the QR code or manually enter the authentication secret code. Save the authenticator entry.
    3. In your browser, click Continue.
    4. Enter the six-digit code from your authenticator app, and click Continue. Authenticate your account screenshot
  5. Add your first store. Add Store Screenshot
    note

    If your store is already registered in the Bold Account Center, reach out to the administrator of that store and request an invitation. You will receive an email with instructions for joining the store.

    1. Select your platform from the Platform drop-down menu.
    2. Enter your Store URL in the input box.
    3. Use the Currency drop-down to select the currency you want your store to use.
    4. Click Add store.
  6. A message appears to confirm you've successfully added your first store. You can now go to the Account Center Launchpad, or invite users to manage your store. For more information, refer to Invite or Deactivate a user in Account Center. Invite Users Screenshot
note

For help with Bold Account Center, refer to the Help Center.

Create an API access token

To set up an API access token in Account Center, follow the steps below:

  1. From within Account Center, expand the left-hand menu and click API access tokens.
  2. Click Create API access token.
  3. Enter the API access token name and select the scopes as shown in the screenshot below. Adobe scopes
  4. Click Create. A dialog box appears and provides a shared secret and API access token.
    caution

    Be sure to save the shared secret and API access token in a secure location, as they will disappear when you close the dialog.

    You will use the shared secret and API access token to configure Adobe Commerce to call Bold Checkout.
  5. Click Done.

Install Bold Checkout

To install Bold Checkout from within Bold Account Center, follow the steps below:

  1. In Bold Account Center, navigate to Launchpad.
  2. In the Available Bold apps section, click Add under Bold Checkout.
  3. Click Accept and Continue to agree to the terms of service and privacy policy.
  4. Once complete, you are redirected to the Bold Checkout admin.

Configure Bold Checkout

Configure Bold Checkout by following the steps below:

  1. From within Bold Checkout, navigate to Payment options > Payment gateways. Payment gateway page

    1. To add a development gateway intended for testing, slide the toggle to the right to enable Development mode. Bold recommends first connecting a payment gateway in development mode so that you can ensure everything is set up correctly.
    2. To add a production payment gateway, toggle off Development mode, and set up a supported payment gateway in the Connect a payment gateway section. Bold strongly recommends using PayPal Complete Payments (PPCP) or Braintree as payment gateways with Adobe Commerce.
  2. Navigate to Settings > General settings.

    1. Scroll down to the Checkout Process section. If company name or phone number are required fields on your Adobe Commerce platform, you must configure these settings to match your store settings.

      Name and Phone settings

      note

      You can also toggle the phone number requirement setting using the Update Phone Number Requirement endpoint.

    2. Click Save.

Add the platform connector in Bold Account Center

Add the Platform Connector for Adobe Commerce to your store by following the steps below:

  1. Within Bold Account Center, navigate to Launchpad, and select the Integrations tab.
  2. Click the Add button on the Platform Connector for Adobe Commerce card.
    note

    If you have more than one store in Bold Account Center, a drop-down appears for you to select the desired store.

    Screenshot of integrations page, featuring Platform Connector for Adobe Commerce
  3. Review the required scope permissions, and click Approve to accept them.

Install and configure the Bold Checkout Extension on Adobe

The Bold Checkout Extension is an Adobe Commerce extension that must be installed on your store. For general instructions on how to install an extension, refer to the Adobe Experience League.

Use the steps in this section to set up Bold Checkout as an extension on your store.

Add the extension on your Adobe Commerce store

To install the extension on your store, follow the steps below.

  1. Open your terminal and navigate to your project directory.
  2. Run the following Composer command to install Bold Platform and Bold Checkout.
    composer require bold-commerce/module-checkout
  3. Enable the extension using the following commands:
    bin/magento setup:di:compile
    bin/magento setup:upgrade
note

Your extension must use version 1.1.27 or later to utilize Payment Booster. If your store was already set up and you want to begin using Payment Booster, update your module using the following command:

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

Configure the extension

Complete the following steps in your Adobe Commerce admin to configure Bold Checkout on your store.

  1. In the Adobe Commerce admin, navigate to Stores > Configuration. Configuration menu screenshot
  2. If you have multiple websites, find the the Scope drop-down menu at the top of the page, and select the website you would like to configure. Skip this step if you are in Single Store Mode.
    note

    In Adobe Commerce versions earlier than 2.4, this drop-down is titled Store View.

    Scope dropdown screenshot
  3. In the left-hand menu of the Configuration page, navigate to Sales > Checkout. Scope dropdown screenshot
  4. Expand the Bold Checkout Extension section, and configure your integration. Bold Checkout extension settings in Adobe admin
    1. In the Enable Bold Checkout drop-down menu, select Yes.
    2. In the Bold Checkout Type drop-down menu, choose Self-Hosted (Adobe storefront).
    3. In the Payment Title field, enter the text that you want to display on the payment option. In the following screenshot, the merchant used "Pay with PayPal or Credit Card" as the payment title. Screenshot of Payment Booster feature
    4. In the API Token field, enter your API access token.
    5. In the Bold Extension Email drop-down, select which existing Adobe Commerce user's email you would like to use.
    6. The Bold Extension Status says "Not Found" or "Inactive". This is expected.
  5. Optional: Expand the Bold Checkout Extension Advanced Setting section, and configure advanced settings. Bold Checkout extension settings in Adobe admin
    1. If you do not want to enable Bold Checkout for all traffic on your store, select a traffic routing method from the Enabled For drop-down menu.
      note

      This setting is useful for testing out the extension for a few users before enabling it globally.

    2. Do not change the Adobe Commerce Platform Connector API URL, API URL, or Checkout URL settings.
    3. If you want to send log information to your logging folder at var/log/debug.log, select Yes from the Enable Bold Checkout Requests Log.
    4. Click the Save Config button.

Activate the extension

Complete the steps below to activate the extension on your Adobe Commerce store.

  1. In your Adobe Commerce admin, navigate to System > Integrations. Screenshot of integrations menu
  2. In the list of integrations, find BoldPlatformIntegration{websiteId}. Click Activate.
    note

    If you only have one website, the integration is called BoldPlatformIntegration1. The suffix number changes depending on the number of stores you choose to integrate with Bold Checkout.

    Screenshot of integrations list
  3. When prompted to allow access to requested resources, click Allow. The extension authenticates and completes installation.
    caution

    If a failure message appears, do not click Reauthorize. Instead, delete the integration from the Integrations page in the Adobe admin, return to the Stores > Settings > Configuration page, and re-save the configuration.

Place a test order

To ensure everything is set up correctly, you can place a test order using development mode and your associated gateway's test card. Once development mode is off, you can also test your store configuration using real payment data.

Follow the steps below to place a test order in development mode.

  1. From within Bold Checkout, navigate to Payment Options > Payment Gateways.
  2. Ensure that Development mode is toggled on.
  3. Navigate to your Adobe Commerce storefront, select an item, and proceed to checkout.
  4. Use your payment gateway's associated test credit card to complete the order.
  5. Once your order successfully completes, return to the Payment Gateways page in the Bold Checkout admin and turn Developer mode off.