Sales > Payment Methods > Braintree
IMPORTANT
Commerce 2.4 Migration:
For versions of ÃÛ¶¹ÊÓƵ Commerce and Magento Open Source earlier than 2.4.0, it was recommended that merchants install and configure the official Braintree payment integration extension from the to replace the core integration. As of 2.4.0, the extension is now included in the core release.
When migrating to Commerce 2.4, merchants need to uninstall the extension distributed on the Marketplace (
If you are upgrading to Commerce 2.4.0 and do not use the recommended Commerce Marketplace extension in your previous 2.3.x version, the multi address feature does not work with the 2.4.0 version of Braintree. When a shopper selects deliver to multiple addresses , the Braintree payment method does not appear. The Commerce Marketplace extension previously recommended for 2.3.x has this multiple address issue.
For versions of ÃÛ¶¹ÊÓƵ Commerce and Magento Open Source earlier than 2.4.0, it was recommended that merchants install and configure the official Braintree payment integration extension from the to replace the core integration. As of 2.4.0, the extension is now included in the core release.
When migrating to Commerce 2.4, merchants need to uninstall the extension distributed on the Marketplace (
paypal/module-braintree or gene/module-braintree) and update any code customizations to use the PayPal_Braintree namespace instead of Magento_Braintree. Configuration settings from the bundled extension for Commerce and the extension distributed on the Commerce Marketplace are persisted. Payments placed with those versions of the extension are captured, voided, or refunded as normal.If you are upgrading to Commerce 2.4.0 and do not use the recommended Commerce Marketplace extension in your previous 2.3.x version, the multi address feature does not work with the 2.4.0 version of Braintree. When a shopper selects deliver to multiple addresses , the Braintree payment method does not appear. The Commerce Marketplace extension previously recommended for 2.3.x has this multiple address issue.
To access the store configuration settings, choose Stores > Settings > Configuration from the Admin sidebar.
Basic Braintree Settings
Title
Store View
Default value:
Credit Card (Braintree)Environment
Store View
Options:
Sandbox / ProductionPayment Action
Store View
Determines the action taken by Braintree when a payment is processed. Options:
Authorize - Funds on the customer’s credit card are authorized, but not transferred from the account. An order is created in your store Admin. You can later capture the sale and create an invoice.Intent Sale (previously Authorize and Capture in earlier releases) - Funds on the customer’s credit card are authorized and captured by Braintree, and an order and invoice are created in your store Admin.Sandbox Merchant ID
Store View
This is the unique identifier for your entire sandbox gateway account. Also known as the public ID or production ID, your merchant ID is different for your production and sandbox gateways. This field appears when the Environment field is set to
Sandbox.Sandbox Public Key
Store View
This is your user-specific, public identifier that restricts access to encrypted data. Each user associated with your Sandbox Braintree gateway has their own sandbox public key. This field appears when the Environment field is set to
Sandbox.Sandbox Private Key
Store View
This is your user-specific, private identifier that restricts access to encrypted data. Each user associated with your Sandbox Braintree gateway has their own private key for the sandbox. This field appears when the Environment field is set to
Sandbox.Merchant ID
Store View
This is the unique identifier for your entire gateway account, including the multiple merchant accounts that may be in your gateway. Also known as the public ID or production ID, your merchant ID is different for your production and sandbox gateways. This field appears when the Environment field is set to
Production.Public Key
Store View
This is your user-specific, public identifier that restricts access to encrypted data. Each user associated with your Braintree gateway has their own public key. This field appears when the Environment field is set to
Production.Private Key
Store View
This is your user-specific, private identifier that restricts access to encrypted data. Each user associated with your Braintree gateway has their own private key. This field appears when the Environment field is set to
Production.Enable Card Payments
Website
Determines if the Braintree credit card payment method is available to your customers as a payment method. Options:
Yes / NoEnable Vault for Card Payments
Website
When enabled, provides secure storage for customer payment information, so customers don’t have to re-enter their credit card information for each purchase. Options:
Yes / NoEnable Vault CVV Reverification
Website
When enabled, validation is done for the CVV rules setup in your Braintree Account. Options:
Yes / NoAdvanced Braintree Settings
Vault Title
Website
A descriptive title for your reference that identifies the vault where your customer card information is stored.
Merchant Account ID
Website
The Merchant Account ID that is to be associated with Braintree transactions from this website. If left blank, the default merchant account from your Braintree account is used.
Enable Checkout Express Payments
Website
Provides a faster checkout experience with Express Payment options at the beginning of the checkout process, including PayPal, PayLater, Apple Pay, and Google Pay. Options:
Yes / NoSkip Fraud Checks on Admin Orders
Website
Prevents the transaction from being sent for evaluation as part of Advanced Fraud Tools checks, on orders placed through the admin only when it set to
Options:
Yes.Options:
Yes / NoBypass Fraud Protection Threshold
Website
Advanced Fraud Protection checks are bypassed when the threshold value is met or exceeded. Leaving this field blank disables this option.Debug
Website
Determines if communications between the Braintree system and your store are recorded in a log file. Options:
Yes / NoCVV Verification
Website
Determines if customers are required to provide the three-digit security code from the back of a credit card. Options:
Yes / NoSend Card Line Items
Website
Send the cart line items for all the payment methods. Options:
Yes / NoCredit Card Types
Website
Specifies each credit card that you accept as payment through Braintree. Press and hold
Ctrl (or Command on Mac) to select a combination of cards. Options: American Express / Visa / MasterCard / Discover / JCB / Diners / Maestro InternationalSort Order
Website
Determines the order that Braintree is listed with other payment methods during checkout.
Braintree Webhooks Settings
Enable Webhook
Website
To enable the webhook functionality for fraud protection, ACH payments, local payment methods, and disputes. Options:
Yes / NoFraud Protection URL
Website
Add this URL into your Braintree Account as the Webhook Destination URL. This URL must be secure and publicly accessible.
Fraud Protection Approve Order Status
Website
When fraud protection is approved by Braintree, the selected order status is assigned to the Commerce order. This status is used to update the status of the order where the ACH payment method is used and when it moves to
SETTLED in Braintree.Fraud Protection Reject Order Status
Website
When fraud protection is rejected by Braintree, the selected order status is assigned to the Commerce order. This status is used to update the status of the order where the ACH payment method is used and when
SETTLEMENT is DECLINED in Braintree.Country Specific Settings
Payment from Applicable Countries
Website
Determines if you accept payments processed by Braintree from all countries, or only specific countries. Options:
All Allowed Countries / Specific CountriesPayment from Specific Countries
Website
If applicable, identifies the specific countries from which you accept payments processed by Braintree.
Country Specific Credit Card Types
Website
Identifies the credit cards that are accepted per country for payments processed by Braintree. A record is saved for each country. Options:
Country - Choose the country.Allowed Card Types - Select each credit card that is accepted from the country as payment through Braintree.Add - Add a line to allow credit cards for a different country.Action - Deletes the record of allowed credit cards for the country.ACH through Braintree
Enabled ACH Direct Debit
Website
Determines if ACH Direct Debit is included as a payment method through Braintree. Options:
Yes / NoEnable Vault for ACH Direct Debit
Website
Customers can vault/store their single-use ACH Direct Debit payment method for future use. Once the payment details are vaulted, the customer can use the ACH Direct Debit payment method without re-entering data or re-authenticating their payment information. Options:
Yes / NoSort Order
Website
Determines the order that ACH Direct Debit is listed with other payment methods during checkout.
Apple Pay through Braintree
Enable ApplePay through Braintree
Website
Determines if Apple Pay is included as a payment method through Braintree. Options:
The domain must be .
Yes / NoThe domain must be .
Enable Vault for ApplePay
Website
Customers can vault/store their Apple Pay payment method for future use. Once the payment details are vaulted, the customer can use Apple Pay without re-entering data or re-authenticating their payment information. Options:
Yes / NoPayment Action
Website
Determines the action taken by Braintree when a payment is processed. Options:
Authorize - Funds on the customer’s card are authorized, but not transferred from the customer’s account. An order is created in your store Admin. You can later capture the sale and create an invoice.Intent Sale - Funds on the customer’s card are authorized and captured by Braintree, and an order and invoice are created in your store Admin. Note: This was Authorize and Capture in 2.3.x and earlier releases.Merchant Name
Store View
Label that is displayed to customers in the ApplePay popup.
Sort Order
Website
Determines the order that Apple Pay is listed with other payment methods during checkout.
Local Payment Methods
Enabled Local Payment Methods
Website
Determines if Local Payment Method is included as a payment method through Braintree. Options:
Yes / NoTitle
Website
Label that appears on the checkout payment method section. Default value:
Local PaymentsFallback Button Text
Website
Enter the text to use for the button that appears on the fallback Braintree page that takes customers back to the website. Default value:
Complete CheckoutRedirect on Fail
Website
Specifies the URL where customers should be redirected when local payment method transactions are cancelled, fail, or encounter errors. It should be the checkout payment page (for example,
https://www.domain.com/checkout#payment).Allowed Payment Method
Website
Select the local Payment method to be enabled. Options:
Bancontact / EPS / giropay / iDeal / Klarna Pay Now / SOFORT / MyBank / P24 / SEPA/ELV Direct Debit (not yet supported)Sort Order
Website
Determines the order that Local Payment Method is listed with other payment methods during checkout.
NOTE
The bundled Braintree extension does not support all the local payment methods listed in the . Other local payment methods are under development to be supported in future releases.
GooglePay through Braintree
Enabled GooglePay through Braintree
Website
Determines if Google Pay payment is included as a payment method through Braintree. Options:
Yes / NoEnable Vault for GooglePay
Website
Customers can vault/store their Google Pay payment method for future use. Once the payment details are vaulted, the customer can use Google Pay without re-entering data or re-authenticating their payment information. Options:
Yes / NoPayment Action
Website
Determines the action taken by Braintree when a payment is processed. Options:
Authorize - Funds on the customer’s card are authorized, but not transferred from the customer’s account. An order is created in your store Admin. You can later capture the sale and create an invoice.Intent Sale - Funds on the customer’s card are authorized and captured by Braintree, and an order and invoice are created in your store Admin. Note: This was Authorize and Capture in 2.3.x and earlier releases.Button Color
Website
Determines the color of the Google Pay button. Options:
White / BlackMerchant ID
Store View
ID provided by Google must be entered here.
Accepted Cards
Website
Select the type of cards that a customer can use to place order using Google Pay.
Sort Order
Website
Determines the order that Google Pay is listed with other payment methods during checkout.
Venmo through Braintree
Enable Venmo through Braintree
Website
Determines if Venmo is included as a payment method through Braintree. Options:
Yes / NoEnable Vault for Venmo
Website
Customers can vault/store their Venmo payment method for future use. Once the payment details are vaulted, the customer can use the Venmo payment method without re-entering data or re-authenticating their payment information. Options:
Yes / NoPayment Action
Website
Determines the action taken by Braintree when a payment is processed. Options:
Authorize - Funds on the customer’s card are authorized, but not transferred from the customer’s account. An order is created in your store Admin. You can later capture the sale and create an invoice.Intent Sale - Funds on the customer’s card are authorized and captured by Braintree, and an order and invoice are created in your store Admin. Note: This was Authorize and Capture in 2.3.x and earlier releases.Sort Order
Website
Determines the order that Venmo is listed with other payment methods during checkout.
PayPal through Braintree
Enable PayPal through Braintree
Website
Determines if PayPal is included as a payment method through Braintree. Options:
Yes / NoEnable PayPal Credit through Braintree
Website
Determines if PayPal Credit is included as a payment method through Braintree. Options:
Yes / No. This field gets visible when Enable PayPal through Braintree is set to YesEnable PayPal PayLater through Braintree
Website
Determines if PayPal PayLater is included as a payment method through Braintree. Options:
Yes / No. This field gets visible when Enable PayPal through Braintree is set to YesTitle
Store View
The label that identifies PayPal through Braintree to customers during checkout. Default value:
PayPalVault Enabled
Website
When enabled, provides secure storage for customer payment information, so customers don’t have to re enter their PayPal information for each purchase. Options:
Yes / NoSend Cart Line Items for PayPal
Website
Send the line items (order items) to PayPal along with Gift Cards, Gift Wrapping for items, Gift Wrapping for order, Store Credit, Shipping, and Tax as line items. Options:
Yes / NoSort Order
Website
A number that determines the order in which PayPal through Braintree is listed with other payment methods during checkout.
Override Merchant Name
Store View
An alternate name that can be used to identify the merchant for each store view.
Payment Action
Website
Determines the action taken by PayPal through Braintree when a payment is processed. Options:
Authorize - Funds on the customer’s card are authorized, but not transferred from the customer’s account. An order is created in your store Admin. You can later capture the sale and create an invoice.Authorize and Capture - Funds on the customer’s card are authorized and captured by PayPal through Braintree, and an order and invoice are created in your store Admin.Payment from Applicable Countries
Website
Determines if you accept payments processed by PayPal through Braintree from all countries, or only specific countries. Options:
All Allowed Countries / Specific CountriesPayment from Specific Countries
Website
If applicable, identifies the specific countries from which you accept payments processed by Braintree.
Require Customer’s Billing Address
Website
Determines if the customer’s billing address is required to submit an order. Options:
Yes / NoDebug
Website
Determines if communications between the PayPal through Braintree system and your store are recorded in a log file. Options:
Yes / NoDisplay on Shopping Cart
Website
Determines if the PayPal button appears in the mini cart and on the shopping cart page. Options:
Yes / NoNOTE
Either PayPal Credit or PayPal PayLater can be enabled. Both methods cannot be enabled at the same.
Styling
Location
Website
Determines where PayPal buttons and messages are rendered on the storefront. Options:
Mini-Cart and Cart Page / Checkout Page / Product PageMini-Cart and Cart Page
The option and settings in this section vary according to the setting in the Location field.
PayPal Button Type
Website
Sets the button to one of three types:
PayPal Button / PayPal Pay Later Button / PayPal Credit ButtonPayPal Button
The options and settings in this section vary according to the button type selected in the PayPal Button Type field.
Show PayPal Button
Website
Determines the location of the PayPal button on the selected location. Options:
Yes / NoButton Label
Website
Determines the label for the PayPal button. Options:
Paypal / Checkout / Buy Now / PayColor
Website
Determines the color of the PayPal button. Options:
Blue / Black / Gold / SilverShape
Website
Determines the shape of the PayPal button. Options:
Pill / RectangleSize(Deprecated)
Website
Determines the size of the PayPal button. Options:
Medium / Large / ResponsiveNOTE
The Size(Deprecated) configuration field is deprecated and not being used to style the PayPal buttons.
PayLater Messaging
Show PayLater Messaging
Website
Enables PayLater messaging at the selected location. Options:
Yes / No. When enabled, it displays PayLater messaging for available offers ().Message Layout
Website
Determines the PayLater message layout. Options:
Text / FlexLogo
Website
Determines the logo type used for the PayPal button. Options:
Inline / Primary / Alternative / NoneLogo Position
Website
Determines the logo position for the PayPal button. Options:
Left / Right / TopText Color
Website
Determines the text color of the PayPal button. Options:
Black / White / Monochrome / GrayscaleWhen these options are set, you can see the preview of the PayPal buttons and PayLater messages. There are controls that you can use to apply the settings or reset the values:
Apply
Website
Stores the selected styling settings for buttons and PayLater messaging and applies them to the current location and current button type.
Apply to All Buttons
Website
Stores the selected styling settings for buttons and PayLater messaging values and applies them to all button types and locations.
Reset to Recommended Defaults
Website
Returns the styling settings to the recommended default values for buttons and PayLater messaging and applies them to all button types and locations.
3d Secure Verification Settings
3D Secure Verification
Website
Determines if a transaction must pass an extra verification process when the customer is enrolled in a program such as Verified by VISA. Options:
Yes / NoAlways request 3DS
Website
Challenge the 3D Secure request always for all the transactions. Options:
Yes / NoThreshold Amount
Website
Determines the maximum order amount that is authorized for processing on a single order. Braintree declines authorization if the order amount exceeds this threshold amount.
Verify for Applicable Countries
Website
Determines the countries where payment must be verified. Options:
All Allowed Countries / Specific CountriesVerify for Specific Countries
Website
If applicable, identifies the specific countries from which payment by Braintree must be verified.
Dynamic Descriptors
Name
Store View
There are two parts to the Name descriptor, which are separated by an asterisk (*). The first part of the descriptor identifies the company or DBA and the second part identifies the product. For example:
The length of the Company and Product parts of the descriptor can be allocated in the following ways, for a combined length of up to 22 characters:
company*myproductThe length of the Company and Product parts of the descriptor can be allocated in the following ways, for a combined length of up to 22 characters:
Option 1 - Company must be three characters / Product can be up to 18 charactersOption 2 - Company must be seven characters / Product can be up to 14 charactersOption 3 - Company must be 12 characters / Product can be up to nine charactersPhone
Store View
The Phone descriptor must be ten to 14 characters in length, and can include only numbers, dashes, parentheses, and periods. For example:
9999999999 (999) 999-9999 999.999.9999URL
Store View
The URL descriptor represents your domain name, and can be up to 13 characters long. For example:
company.comrecommendation-more-help
d39aca6f-58a0-41c6-83eb-39fd0ef30672