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 Express Checkout
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.
Stores > Settings > Configuration > Sales > Payment Methods > PayPal Express Checkout
Payment Services Directive Requirements:
As of September 14, 2019, European banks might decline payments that do not meet PSD2 requirements. No action is needed for PayPal Express Checkout to comply with PSD2 because all requirements are handled by PayPal.
Required PayPal Settings
PayPal Express Checkout Required Settings
Express Checkout
| Field | Scope | Description |
|---|---|---|
| Email Associated with PayPal Merchant Account | Website | Specifies the email address that you specified when your PayPal merchant account was established. The email address is case sensitive, and must exactly match your email address in the PayPal system. |
| API Authentication Methods | Website | Determines the method used for API authentication. Options: API Signature - Displays the API Signature field in the form. API Certificate - Displays the API Certificate field in the form. |
| API Username | Website | The API user name that is associated with your PayPal merchant account. |
| API Password | Website | The API password that is associated with your PayPal merchant account. |
| API Signature | Website | The API signature that is associated with your PayPal merchant account. |
| API Certificate | Website | Browse to upload your API certificate. |
| Get Credentials from PayPal | Fetches your API credentials from PayPal. | |
| Sandbox Credentials | Fetches your sandbox credentials from PayPal. | |
| Sandbox Mode | Website | To run PayPal Express Checkout in a test environment, enter your sandbox API credentials, and then set Sandbox Mode to “Yes”. Options: Yes / No |
| API Uses Proxy | Website | If your system uses a proxy server to establish the connection between Magento and the PayPal system, set API Uses Proxy to “Yes”. Options: Yes / No |
| Proxy Host | Website | If the API uses proxy, the IP address of the proxy host. |
| Proxy Port | Website | If the API uses proxy, the port used by the proxy host. |
| Enable this Solution | Website | Activates PayPal Express Checkout as a payment method that is available to your customers. Options: Yes / No |
| Enable In-Context Checkout Experience | Website | Activates streamlined PayPal In-Context Checkout as a payment method available to your customers. Options: Yes / No |
| Enable Paypal Credit | Website | Activates PayPal Credit to allow customers to buy now, but pay later. You get paid up front, but customers have more time to pay. Options: Yes / No |
Advertise PayPal Credit
Advertise PayPal Credit
| Field | Scope | Description |
|---|---|---|
| Publisher ID | Website | The Publisher ID associated with your PayPal Credit account. |
| Get Publisher ID from PayPal | Fetches your Publisher ID from PayPal. | |
| Home Page | Website | Determines the position and size of the PayPal Credit banner on the home page. Options: Display - Displays a PayPal Credit banner on the home page of your store. Options: Yes / No Position - Determines the position of the PayPal Credit banner on the home page. Options: Header (center) / Sidebar (right) Size - Determines the size of the PayPal Credit banner on the home page. Options: 190 x 100 / 234 x 60 / 300 x 50 / 468 x 60 / 728 x 90 / 800 x 66 |
| Catalog Category Page | Website | Determines the position and size of the PayPal Credit banner on category pages. Options: (same as for Home Page) |
| Catalog Product Page | Website | Determines the position and size of the PayPal Credit banner on product pages. Options: (same as for Home Page) |
| Checkout Cart Page | Website | Determines the position and size of the PayPal Credit banner on cart page. Options: (same as for Home Page) |
Basic Settings
Basic Settings
| Field | Scope | Description |
|---|---|---|
| Title | Website | A name that identifies the PayPal Express Checkout payment method during checkout. |
| Sort Order | Website | A number that determines the order that PayPal Express Checkout appears when listed with other payment methods during checkout. Enter 0 for the top of the list. |
| Payment Action | Website | Determines the action taken by PayPal when it receives an order. Options: Authorization - Approves the purchase, but 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. Order - Represents an agreement with PayPal that allows the merchant to capture one or more amounts up to the “ordered” total from the customer’s buyer account, within a defined period of time, which can be up to 29 days. One or more invoices must be generated from the Magento Admin to capture the funds. |
| Display on Product Details Page | Store View | Determines if the “Checkout with PayPal” button appears on product pages. Options include: Yes / No |
Advanced Settings
Advanced Settings
| Field | Scope | Description |
|---|---|---|
| Display on Shopping Cart | Store View | Determines if PayPal Express Checkout appears as a payment option in the shopping cart. Options: Yes (PayPal recommended) / No |
| Payment Action Applicable From | Website | Determines the range of the applicable country selection. Options: All Allowed Countries / Specific Countries |
| Countries Payment Applicable From | Website | Identifies each country from which payment is accepted. Only customers with a billing address in a selected country can make purchases with this payment method. |
| Debug Mode | Website | Records messages sent between your store and the payment system in a log file. Options: Yes / No Note: The log file is stored on the server and is accessible only to developers. In accordance with PCI Data Security Standards, credit card information is not recorded in the log file. |
| Enable SSL Verification | Website | Enables verification of the host security certificate. Options: Yes / No |
| Transfer Cart Line Items | Website | Displays a full summary of the line items from the customer’s shopping cart on the PayPal site. Options: Yes / No |
| Transfer Shipping Options | Website | Includes up to ten shipping options on the PayPal site. Options include: Yes / No |
| Shortcut Buttons Flavor | Store View | Determines the type of image used for the PayPal acceptance button. Options: Dynamic - (Recommended) Displays an image that can be dynamically changed from the PayPal server. Static - Displays a static image that cannot be changed dynamically. |
| Enable PayPal Guest Checkout | Website | Allows customers who do not have PayPal accounts to make purchases with PayPal Express Checkout. Options: Yes / No |
| Require Customer’s Billing Address | Website | Determines if the customer billing address is required. Options: Yes, No, For Virtual Quotes Only |
| Billing Agreement Signup | Website | Determines if customers have the option to enter into a billing agreement with your store. Options: Auto - Customer can sign up for a billing agreement during Express Checkout. Ask Customer - Customer are asked if they want to sign up for a billing agreement. Never - Customers are not offered the option to sign up for a billing agreement. |
| Skip Order Review Step | Website | Determines if customers can complete the transaction from the PayPal site, or are required to return to your store and complete the Order Review step before submitting the order. Options: Yes / No |
Billing Agreement Settings
Billing Agreement Settings
| Field | Scope | Description |
|---|---|---|
| Enabled | Website | When enabled, billing agreements appear to customers as a payment option during checkout. Options: Yes / No |
| Title | Store View | The label for the PayPal billing agreement option that appears as a payment option during checkout. |
| Sort Order | Store View | Determines the order in which billing agreements are listed with other payment methods during checkout. |
| Payment Action | Website | Determines how PayPal manages the transaction: Options: Authorization - Approves the purchase, but 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. |
| Payment Applicable From | Website | Determines the range of the applicable country selection. Options: All Allowed Countries / Specific Countries |
| Countries Payment Applicable From | Website | Identifies each country from which payment is accepted. Only customers with a billing address in a selected country can make purchases with this payment method. |
| Debug Mode | Website | Records communication with the payment system in a log file. Options: Yes / No Note: The log file is stored on the server and is accessible only to developers. In accordance with PCI Data Security Standards, credit card information is not recorded in the log file. |
| Enable SSL Verification | Website | Enables a verification step to that ensures the transaction takes place over an encrypted SSL channel. Options: Yes / No |
| Transfer Cart Line Items | Website | When enabled, displays a summary of line items from the shopping cart on your PayPal payments page. Options: Yes / No |
| Allow in Billing Agreement Wizard | Website | When enabled, customers can initiate a billing agreement from the dashboard of their customer account. |
Settlement Report Settings
Settlement Report Settings
| Field | Scope | Description |
|---|---|---|
| SFTP Credentials | ||
| Login | Website | Your user name that is required to log in to PayPal’s Secure FTP Server. |
| Password | Website | Your password that is required to log in to PayPal’s Secure FTP Server. |
| Sandbox Mode | Website | When enabled, runs reports in a test environment before “going live” in the production environment. Options: Yes / No |
| Custom Endpoint Hostname or IP-Address | Website | The URL where settlement reports are managed. Default value: reports.paypal.com |
| Custom Path | Website | The path were settlement reports are saved on your server. Default value: /ppreports/outgoing |
| Scheduled Fetching | ||
| Enable Automatic Fetching | Website | When enabled, fetches settlement reports automatically on schedule. Options: Yes / No |
| Schedule | Website | Determines how often settlement reports are generated by PayPal. Options: Daily / Every 3 days / Every 7 days / Every 10 days / Every 14 days / Every 30 days / Every 40 days |
| Time of Day | Website | Determines the hour, minute, and second that settlement reports are generated. |
Frontend Experience Settings
Frontend Experience Settings - PayPal Merchant Pages Style
| Field | Scope | Description |
|---|---|---|
| PayPal Product Logo | Website | Determines the PayPal logo that appears in your store. There are four basic style in two sizes. Options: No Logo / We prefer PayPal (150 x 60) / We prefer PayPal (150 x 40, ) / Now accepting PayPal (150 x 60) / Now accepting PayPal (150 x 40) / Payments by PayPal (150 x 60) / Payments by PayPal (150 x 40) / Shop now using (150 x 60) / Shop now using (150 x 40) |
| PayPal Merchant Pages Style | ||
| Page Style | Website | Determines the appearance of your PayPal merchant page. Permitted values: 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. |
| Header Image URL | Website | The URL of the image that appears in the upper-left corner of the checkout page. The maximum size is 750 x 90 pixels. Note: PayPal recommends that the image be located on a secure (https) server. Otherwise, the customer’s browser may warn that “the page contains both secure and nonsecure items.” |
| Header Image Background Color | Website | The six-character hexadecimal color code for the background color of the header on the checkout page. You can enter the code in either upper- and lowercase characters. |
| Header Image Border Color | Website | The six-character hexadecimal color code for the two-pixel border around the header. |
| Page Background Color | Website | The six-character hexadecimal color code for the background color of the checkout page that appears behind the header and payment form. |
Customize Smart Buttons (Basic)
Frontend Experience Settings - Customize Smart Buttons
| Field | Scope | Description |
|---|---|---|
| Customize Button | Store view | Determines whether the PayPal Smart Buttons can be customized to match the layout and theme of your store. You can apply these changes independently on the Checkout page, on Product pages, on the Cart page, and in the Mini Cart. |
| Label | Store view | The text that PayPal displays on the Smart Payment Button. Options: Checkout (displays as “PayPal Checkout”) Pay (displays as “Pay with PayPal”) Buy Now (displays as “Buy Now with PayPal”) PayPal (displays as “PayPal”) Installment (displays as “PayPal”) Credit (displays as “PayPal CREDIT”) |
| Layout | Store view | Determines whether to display PayPal Smart Buttons vertically or horizontally. Options: Vertical - The buyer must either log in to PayPal or create a PayPal account regardless of whether “Enable Guest Checkout” is selected. Horizontal - When “Enable Guest Checkout” is selected, displays the Pay with Debit Card or Credit Card button on the PayPal popup window. Otherwise, the buyer must either log in to PayPal or create a PayPal account. |
| Size | Store view | Sets the size of the Smart Payment Button. Options: Medium - 250 pixels by 35 pixels Large - 350 pixels by 40 pixels Responsive - (Default) Adjusts to the width of the container. The minimum width is 100 pixels, and the maximum width is 500 pixels. The height dynamically adjusts based on the width. |
| Shape | Store view | Sets the shape of the Smart Payment Button. Options: Pill (Default) / Rectangle |
| Color | Store view | Set the color of the Smart Payment Button. Options: Gold (Default) / Blue / Silver / Black |
Customize Smart Buttons (Features)
Frontend Experience Settings - Customize Smart Buttons (Features)
| Field | Scope | Description |
|---|---|---|
| Disable Funding Options | Store view | Determines which other PayPal funding options are displayed on the Checkout page. The selected options will never be displayed on the Checkout page. Unselected options will be displayed only if PayPal supports the store’s currency and the buyer’s location. Options: PayPal Credit / PayPal Guest Checkout Credit Card Icons / Elektronisches Lastschriftverfahren - German ELV |