After July 2021, the 2.3.x release line no longer received quality updates or user guide updates. PHP 7.3 reached end of support in December 2021, and Adobe Commerce 2.3.x reached end of support in September 2022. We strongly recommend upgrading to Adobe Commerce 2.4.x to help maintain PCI compliance.

PayPal Payflow Link

This site contains archived merchant documentation for a version of Adobe Commerce and Magento Open Source that has reached end-of-support. The documentation available here is intended for historical reference only and is not maintained. The Adobe Commerce Merchant Documentation for current releases is published on the Adobe Experience League.

PayPal PayFlow Link is available for merchants in the United States and Canada only. Customers are not required to have a personal PayPal account, and enter their credit card information in a form that is hosted by PayPal. The information is never stored on your Magento server. PayFlow Link cannot be used for orders that are created from the Admin.

Credit memos are supported for both online and offline refunds. However, multiple online refunds are not supported.

Payment Services Directive Requirements:
As of September 14, 2019, European banks might decline payments that do not meet PSD2 requirements. To comply with PSD2, PayPal Payflow Link must be integrated with Cardinal Commerce. To learn more, see 3-D Secure for Payflow.

Requirements

  • PayPal Business Account The PayPal Payflow Pro gateway links the merchant account at PayPal with the merchant website, acting as both a gateway and a merchant account.

  • If you manage multiple Magento websites, you must have a separate PayPal merchant account for each website.

Customer workflow

1 Customer goes to checkout During checkout, the customer chooses to pay with PayPal PayFlow link and enters the credit card information. The customer is not required to have a personal PayPal account.
2 Customer chooses Pay Now The customer taps the Pay Now button to submit the order.
3 Customer enters credit card information The customer enters the credit card information on a form that is hosted by PayPal. If the customer clicks the Cancel Payment link, the customer returns to the Payment Information stage of checkout and the order status changes to Canceled.
4 Customer submits the order The credit card information is submitted directly to PayPal and is not retained anywhere on the Magento site.

Order workflow

1 PayPal receives request PayPal receives the request from the customer to Pay Now.
2 PayPal verifies the payment information PayPal verifies the credit card information, and assigns the appropriate status.
Payment Verified: If verified, the Pending Payment status is initially assigned to the order until the transaction is settled.
- Processing - The transaction was successful.
- Pending Payment - The system did not receive a response from PayPal.
- Canceled - The transaction was not successful for some reason.
- Suspected Fraud - The transaction did not pass some of the PayPal fraud filters. The system receives the response from PayPal that the transaction is under review by Fraud Service.
Cancel Payment: If the customer clicks the Cancel Payment link, the customer returns to the Payment Information stage of checkout and the order status changes to Canceled.
3 Customer is redirected to confirmation page If the transaction is completed successfully, the customer is redirected to the order confirmation page in your store. If the transaction fails on any reason, an error message appears on the checkout page and the customer is directed to repeat the checkout process. These situations are managed by PayPal.
4 Merchant fulfills order The merchant invoices and ships the order as usual.

Configure your PayPal account

  1. Log in to your PayPal business account.

  2. Configure the Hosted Checkout Pages using PayPal Manager with the following settings:

    • Under Security Options, complete the following settings:

      AVS No
      CSC No
      Enable Secure Token Yes
    • Choose Customize, and then choose Layout C.

      Layout C shows only credit and debit card fields, and can either be framed on your site or used as a stand-alone popup. The size is fixed at 490 x 565 pixels, with extra space for error messages. On some systems, this setting corrects an issue with transparent redirect.

  3. When the configuration settings are complete, click Save and Publish.

  4. Set up an additional user (recommended by PayPal):

    • In the second row of the main menu, click Manage Users.

    • To add another user to the account, click Add User. The link is located just above the Manage Users title.

    • Complete the required fields in the following sections of the Add User form:

      • Admin Confirmation
      • User Information
      • User Login Information
      • Assign Privilege to User
    • Click Update.

Click Save Config at any time to save your progress.

Step 1: Begin the Magento configuration

This setup method assumes you have an existing PayPal account.

  1. On the Admin sidebar, go to Stores > Settings > Configuration.

  2. In the left panel, expand Sales and choose Payment Methods.

  3. If your Magento installation has multiple websites, stores, or views, set Store View to the store view where you want to apply this configuration.

  4. In the Merchant Location section, select the Merchant Country where your business is located.

    This setting determines the selection of PayPal Solutions that appear in the configuration.

    Merchant Country Merchant Country

  5. Expand PayPal Payment Gateways (if needed) and click Configure for Payflow Link.

    Configure Payflow Link - Configure

Step 2: Complete the required PayPal settings

Required Settings Required PayPal Settings - PayPal Payflow Link

  1. (Optional) Enter the Email Associated with your PayPal Merchant Account.

    Email addresses are case sensitive. To receive payment, the email address must match the email address specified in your PayPal merchant account.

  2. Enter one of the following credentials that you use to log in to your PayPal merchant account:

    Partner Your PayPal Partner ID.
    User The ID of an additional user who is set up on your PayPal account.
    Vendor Your PayPal user login name.
  3. Enter the Password that is associated with your PayPal account.

  4. If you want to run test transactions, set Test Mode to Yes.

    When testing the configuration in a sandbox, use only credit card numbers that are recommended by PayPal. When you are ready to go live, return to the configuration and set Test Mode to No.

  5. If your system uses a proxy server to establish the connection to the PayPal system, set Use Proxy to Yes and do the following:

    • Enter the IP address of the Proxy Host.

    • Enter the port number of the Proxy Port.

      A proxy is used when the server firewall prevents direct access to the PayPal server. In such a case, a third-party server is used to relay traffic.

  6. Set Enable Payflow Link to Yes.

  7. If you want to enable PayPal Express Checkout options for customers, set Enable Express Checkout to Yes.

  8. If you want to offer PayPal Credit to your customers, set Enable PayPal Credit to Yes.

Step 4: Set up Advertise PayPal Credit (optional)

  1. Expand the Advertise PayPal Credit section.

    Advertise PayPal Credit Advertise PayPal Credit

  2. Click Get Publisher ID from PayPal and follow the instructions to get your account information.

  3. Enter your Publisher ID.

  4. Expand the Home Page section.

    Advertise PayPal Credit Home Page Settings Advertise PayPal Credit - Home Page

  5. To place a banner on the page, set Display to Yes.

  6. Set Position to one of the following:

    • Header (center)
    • Sidebar (right)
  7. Set Size to one of the following:

    • 190 x 100
    • 234 x 60
    • 300 x 50
    • 468 x 60
    • 728 x 90
    • 800 x 66
  8. Expand the remaining sections and repeat the previous steps for home page configuration:

    • Catalog Category Page
    • Catalog Product Page
    • Checkout Cart Page

Step 5: Complete the basic Settings

  1. Expand the Basic Settings - PayPal Payflow Link section.

    Basic Settings Basic Settings - PayPal Payflow Link

  2. Enter a Title to identify PayPal Payflow Link during checkout.

    It is recommended that you use the title Debit or Credit Card.

  3. If you offer multiple payment methods, enter a number for Sort Order to determine the sequence in which Payflow Link appears when listed with the other payment methods.

    This is relative to the other payment methods. (0 = first, 1 = second, 2 = third, and so on.)

  4. Set Payment Action to one of the following:

    Authorization Approves the purchase and puts a hold on the funds. The amount is not withdrawn until it is captured by the merchant.
    Sale The amount of the purchase is authorized and immediately withdrawn from the customer’s account.

Step 6: Complete the advanced settings

  1. Expand the Advanced Settings section.

    Advanced Settings Advanced Settings - PayPal Payflow Link

  2. Set Payment Applicable From to one of the following:

    All Allowed Countries Customers from all countries specified in your store configuration can use this payment method.
    Specific Countries After choosing this option, the Payment from Specific Countries list appears. Hold down the Ctrl key and select each country in the list where customers can make purchases from your store.
  3. To write communications with the payment system into the log file, set Debug Mode to Yes.

    In accordance with PCI Data Security Standards, credit card information is not recorded in the log file.

  4. To enable host authenticity verification, set Enable SSL verification to Yes.

  5. If you want the customer to be able to correct their entry of the three-digit CVV security code from the back of a credit card, set CVV Entry is Editable to Yes.

  6. To require that customers enter a CVV code, set Require CVV Entry to Yes.

  7. To send a confirmation of the payment to the customer, set Send Email Confirmation to Yes.

  8. To determine the method that is used to exchange information with the PayPal server during a transaction, set the URL method for Cancel URL and Return URL to one of the following:

    GET Retrieves information that is the result of a process. (This is the default method.)
    POST Provides a block of data, such as data entered into a form, to a data handling process.

    The Cancel URL and Return URL refer to the page where a customer returns after completing or canceling the payment part of the checkout process on the PayPal server

  9. Complete the following sections, as needed for your store:

Settlement Report Settings

  1. Expand the Settlement Report Settings section.

    Settlement Report Settings Settlement Report Settings - PayPal Payflow Pro

  2. For SFTP Credentials, do the following:

    • If you have signed up for the PayPal Secure FTP Server, enter the following SFTP login credentials:

      • Login
      • Password
    • To run test reports before going live with Express Checkout on your site, set Sandbox Mode to Yes.

    • Enter the Custom Endpoint Hostname or IP Address.

      By default, the value is: reports.paypal.com

    • Enter the Custom Path where reports are saved.

      By default, the value is: /ppreports/outgoing

  3. To generate reports according to a schedule, complete the Scheduled Fetching settings:

    • Set Enable Automatic Fetching to Yes.

    • Set Schedule to one of the following:

      • Daily
      • Every 3 Days
      • Every 7 Days
      • Every 10 Days
      • Every 14 Days
      • Every 30 Days
      • Every 40 Days

      PayPal retains each report for 45 days.

    • Set Time of Day to the hour, minute, and second when you want the reports to be generated.

Frontend Experience Settings

The Frontend Experience Settings give you the opportunity to choose which PayPal logos appear on your site, and to customize the appearance of your PayPal merchant pages.

  1. Expand the Frontend Experience Settings section.

    Frontend Experience Settings Frontend Experience Settings - PayPal Payflow Pro

  2. Select the PayPal Product Logo that you want to appear in the PayPal block in your store.

    The PayPal logos are available in four styles and two sizes:

    • No Logo
    • We Prefer PayPal (150 x 60 or 150 x 40)
    • Now Accepting PayPal (150 x 60 or 150 x 40)
    • Payments by PayPal (150 x 60 or 150 x 40)
    • Shop Now Using PayPal (150 x 60 or 150 x 40)
  3. To customize the appearance of your PayPal merchant pages, do the following:

    • Enter the name of the Page Style that you want to apply to your PayPal merchant pages:

      paypal Uses the PayPal page style.
      primary Uses the page style that you identified as the primary style in your account profile.
      your_custom_value Uses a custom payment page style, which is specified in your account profile.
    • For Header Image URL, enter the URL of the image that you want to appear in the upper-left corner of the payment page. The maximum file size is 750 pixels wide by 90 pixels high.

      PayPal recommends that the image be located on a secure (https) server. Otherwise, a browser may warn that the page contains both secure and nonsecure items.

    • To set the color for your pages, enter the six-character hexadecimal code, without the # symbol, for each of the following:

      Header Background Color Background color for the checkout page header.
      Header Border Color Color for two-pixel border around the header.
      Page Background Color Background color for the checkout page and around the header and payment form.

Step 6: Complete the basic settings for PayPal Express Checkout

  1. Expand the Basic Settings - PayPal Express Checkout section.

    Basic Settings Basic Settings - PayPal Express Checkout

  2. Enter a Title to identify this payment method during checkout.

    It is recommended to set the title to PayPal for each store view.

  3. If you offer multiple payment methods, enter a number for Sort Order to determine the sequence in which PayPal Express Checkout appears when listed with the other payment methods.

    This is relative to the other payment methods. (0 = first, 1 = second, 2 = third, and so on.)

  4. Set Payment Action to one of the following:

    Authorization Approves the purchase and puts a hold on the funds. The amount is not withdrawn until it is captured by the merchant.
    Sale The amount of the purchase is authorized and immediately withdrawn from the customer’s account.
  5. To display the Check out with PayPal button on the product page, set Display on Product Details Page to Yes.

Step 7: Complete the advanced settings for PayPal Express Checkout

  1. Expand the Advanced Settings section.

    Advanced Settings Advanced Settings - PayPal Express Checkout

  2. Set Display on Shopping Cart to Yes.

  3. Set Payment Applicable From to one of the following:

    All Allowed Countries Customers from all countries specified in your store configuration can use this payment method.
    Specific Countries After choosing this option, the Payment from Specific Countries list appears. To select multiple countries, hold down the Ctrl key (PC) or the Command key (Mac) and click each item.
  4. To write communications with the payment system into the log file, set Debug Mode to Yes.

    In accordance with PCI Data Security Standards, credit card information is not recorded in the log file.

  5. To enable host authenticity verification, set Enable SSL Verification to Yes.

  6. To display a full summary of the customer order by line item from the PayPal site, set Transfer Cart Line Items to Yes.

  7. To allow the customer to complete the transaction from the PayPal site without returning to your Magento store for Order Review, set Skip Order Review Step to Yes.

  8. When complete, click Save Config.