Basic Braintree Settings

Basic Braintree Settings

FieldScopeDescription
TitleStore ViewDefault value: Credit Card (Braintree)
EnvironmentStore ViewOptions: Sandbox / Production
Payment ActionStore ViewDetermines 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 IDStore ViewThis 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 KeyStore ViewThis 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 KeyStore ViewThis 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 IDStore ViewThis 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 KeyStore ViewThis 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 KeyStore ViewThis 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 PaymentsWebsiteDetermines if the Braintree credit card payment method is available to your customers as a payment method. Options: Yes / No
Enable Vault for Card PaymentsWebsiteWhen 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 / No
Enable Vault CVV ReverificationWebsiteWhen enabled, validation is done for the CVV rules setup in your Braintree Account. Options: Yes / No

Advanced Braintree Settings

Braintree Advanced Settings

FieldScopeDescription
Vault TitleWebsiteA descriptive title for your reference that identifies the vault where your customer card information is stored.
Merchant Account IDWebsiteThe 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 PaymentsWebsiteProvides 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 / No
Skip Fraud Checks on Admin OrdersWebsitePrevents 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 Yes.
Options: Yes / No
Bypass Fraud Protection ThresholdWebsiteAdvanced Fraud Protection checks are bypassed when the threshold value is met or exceeded. Leaving this field blank disables this option.
DebugWebsiteDetermines if communications between the Braintree system and your store are recorded in a log file. Options: Yes / No
CVV VerificationWebsiteDetermines if customers are required to provide the three-digit security code from the back of a credit card. Options: Yes / No
Send Card Line ItemsWebsiteSend the cart line items for all the payment methods. Options: Yes / No
Credit Card TypesWebsiteSpecifies 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 International
Sort OrderWebsiteDetermines the order that Braintree is listed with other payment methods during checkout.

Braintree Webhooks Settings

Braintree Webhooks Settings

FieldScopeDescription
Enable WebhookWebsiteTo enable the webhook functionality for fraud protection, ACH payments, local payment methods, and disputes. Options: Yes / No
Fraud Protection URLWebsiteAdd this URL into your Braintree Account as the Webhook Destination URL. This URL must be secure and publicly accessible.
Fraud Protection Approve Order StatusWebsiteWhen 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 StatusWebsiteWhen 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

Country Specific Settings

FieldScopeDescription
Payment from Applicable CountriesWebsiteDetermines if you accept payments processed by Braintree from all countries, or only specific countries. Options: All Allowed Countries / Specific Countries
Payment from Specific CountriesWebsiteIf applicable, identifies the specific countries from which you accept payments processed by Braintree.
Country Specific Credit Card TypesWebsiteIdentifies 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

ACH through Braintree

FieldScopeDescription
Enabled ACH Direct DebitWebsiteDetermines if ACH Direct Debit is included as a payment method through Braintree. Options: Yes / No
Enable Vault for ACH Direct DebitWebsiteCustomers 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 / No
Sort OrderWebsiteDetermines the order that ACH Direct Debit is listed with other payment methods during checkout.

Apple Pay through Braintree

Apple Pay through Braintree

FieldScopeDescription
Enable ApplePay through BraintreeWebsiteDetermines if Apple Pay is included as a payment method through Braintree. Options: Yes / No

The domain must be verified in Braintree Account first.
Enable Vault for ApplePayWebsiteCustomers 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 / No
Payment ActionWebsiteDetermines 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 NameStore ViewLabel that is displayed to customers in the ApplePay popup.
Sort OrderWebsiteDetermines the order that Apple Pay is listed with other payment methods during checkout.

Local Payment Methods

Local Payment Methods

FieldScopeDescription
Enabled Local Payment MethodsWebsiteDetermines if Local Payment Method is included as a payment method through Braintree. Options: Yes / No
TitleWebsiteLabel that appears on the checkout payment method section. Default value: Local Payments
Fallback Button TextWebsiteEnter the text to use for the button that appears on the fallback Braintree page that takes customers back to the website. Default value: Complete Checkout
Redirect on FailWebsiteSpecifies 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 MethodWebsiteSelect 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 OrderWebsiteDetermines 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 Braintree developer documentation. Other local payment methods are under development to be supported in future releases.

GooglePay through Braintree

GooglePay through Braintree

FieldScopeDescription
Enabled GooglePay through BraintreeWebsiteDetermines if Google Pay payment is included as a payment method through Braintree. Options: Yes / No
Enable Vault for GooglePayWebsiteCustomers 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 / No
Payment ActionWebsiteDetermines 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 ColorWebsiteDetermines the color of the Google Pay button. Options: White / Black
Merchant IDStore ViewID provided by Google must be entered here.
Accepted CardsWebsiteSelect the type of cards that a customer can use to place order using Google Pay.
Sort OrderWebsiteDetermines the order that Google Pay is listed with other payment methods during checkout.

Venmo through Braintree

Venmo through Braintree

FieldScopeDescription
Enable Venmo through BraintreeWebsiteDetermines if Venmo is included as a payment method through Braintree. Options: Yes / No
Enable Vault for VenmoWebsiteCustomers 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 / No
Payment ActionWebsiteDetermines 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 OrderWebsiteDetermines the order that Venmo is listed with other payment methods during checkout.

PayPal through Braintree

PayPal through Braintree

FieldScopeDescription
Enable PayPal through BraintreeWebsiteDetermines if PayPal is included as a payment method through Braintree. Options: Yes / No
Enable PayPal Credit through BraintreeWebsiteDetermines 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 Yes
Enable PayPal PayLater through BraintreeWebsiteDetermines 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 Yes
TitleStore ViewThe label that identifies PayPal through Braintree to customers during checkout. Default value: PayPal
Vault EnabledWebsiteWhen enabled, provides secure storage for customer payment information, so customers don’t have to re enter their PayPal information for each purchase. Options: Yes / No
Send Cart Line Items for PayPalWebsiteSend 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 / No
Sort OrderWebsiteA number that determines the order in which PayPal through Braintree is listed with other payment methods during checkout.
Override Merchant NameStore ViewAn alternate name that can be used to identify the merchant for each store view.
Payment ActionWebsiteDetermines 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 CountriesWebsiteDetermines if you accept payments processed by PayPal through Braintree from all countries, or only specific countries. Options: All Allowed Countries / Specific Countries
Payment from Specific CountriesWebsiteIf applicable, identifies the specific countries from which you accept payments processed by Braintree.
Require Customer’s Billing AddressWebsiteDetermines if the customer’s billing address is required to submit an order. Options: Yes / No
DebugWebsiteDetermines if communications between the PayPal through Braintree system and your store are recorded in a log file. Options: Yes / No
Display on Shopping CartWebsiteDetermines if the PayPal button appears in the mini cart and on the shopping cart page. Options: Yes / No
NOTE
Either PayPal Credit or PayPal PayLater can be enabled. Both methods cannot be enabled at the same.

Styling

PayPal Styling

FieldScopeDescription
LocationWebsiteDetermines where PayPal buttons and messages are rendered on the storefront. Options: Mini-Cart and Cart Page / Checkout Page / Product Page

Mini-Cart and Cart Page

The option and settings in this section vary according to the setting in the Location field.

FieldScopeDescription
PayPal Button TypeWebsiteSets the button to one of three types: PayPal Button / PayPal Pay Later Button / PayPal Credit Button

PayPal Button

The options and settings in this section vary according to the button type selected in the PayPal Button Type field.

FieldScopeDescription
Show PayPal ButtonWebsiteDetermines the location of the PayPal button on the selected location. Options: Yes / No
Button LabelWebsiteDetermines the label for the PayPal button. Options: Paypal / Checkout / Buy Now / Pay
ColorWebsiteDetermines the color of the PayPal button. Options: Blue / Black / Gold / Silver
ShapeWebsiteDetermines the shape of the PayPal button. Options: Pill / Rectangle
Size(Deprecated)WebsiteDetermines the size of the PayPal button. Options: Medium / Large / Responsive
NOTE
The Size(Deprecated) configuration field is deprecated and not being used to style the PayPal buttons.

PayLater Messaging

FieldScopeDescription
Show PayLater MessagingWebsiteEnables PayLater messaging at the selected location. Options: Yes / No. When enabled, it displays PayLater messaging for available offers (restrictions apply).
Message LayoutWebsiteDetermines the PayLater message layout. Options: Text / Flex
LogoWebsiteDetermines the logo type used for the PayPal button. Options: Inline / Primary / Alternative / None
Logo PositionWebsiteDetermines the logo position for the PayPal button. Options: Left / Right / Top
Text ColorWebsiteDetermines the text color of the PayPal button. Options: Black / White / Monochrome / Grayscale

When 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:

FieldScopeDescription
ApplyWebsiteStores the selected styling settings for buttons and PayLater messaging and applies them to the current location and current button type.
Apply to All ButtonsWebsiteStores the selected styling settings for buttons and PayLater messaging values and applies them to all button types and locations.
Reset to Recommended DefaultsWebsiteReturns 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 Settings

FieldScopeDescription
3D Secure VerificationWebsiteDetermines if a transaction must pass an extra verification process when the customer is enrolled in a program such as Verified by VISA. Options: Yes / No
Always request 3DSWebsiteChallenge the 3D Secure request always for all the transactions. Options: Yes / No
Threshold AmountWebsiteDetermines 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 CountriesWebsiteDetermines the countries where payment must be verified. Options: All Allowed Countries / Specific Countries
Verify for Specific CountriesWebsiteIf applicable, identifies the specific countries from which payment by Braintree must be verified.

Dynamic Descriptors

Dynamic Descriptors

FieldScopeDescription
NameStore ViewThere 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: company*myproduct

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:
Option 1 - Company must be three characters / Product can be up to 18 characters
Option 2 - Company must be seven characters / Product can be up to 14 characters
Option 3 - Company must be 12 characters / Product can be up to nine characters
PhoneStore ViewThe 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.9999
URLStore ViewThe URL descriptor represents your domain name, and can be up to 13 characters long. For example: company.com
Previous pagePayment Services
Next pagePayPal Express Checkout