Braintree Payment Gateway Set-up

Learn how to install and configure the Braintree payment.

Olga Tereshina avatar
Written by Olga Tereshina
Updated over a week ago

The Braintree Payment Gateway add-on setup consists of the add-on installation itself and the add-on settings configuration:

Enabling Braintree Payment Gateway

To enable Braintree Payment Gateway as a payment method in your online store, add it to the list of your store's active payment methods:

  1. Go to the Payment Methods page (Store Setup> Payment Methods) in your store's Admin area. Then, in the Online methods section, click Add payment method:


  2. In the popup box that appears, find the Braintree method you require (in our case Braintree, a PayPal Company) and select to Add this method:


    The payment will be added.

    If the Braintree Payment Gateway add-on is not installed in your online store at the time of adding the method, there will be an Install button instead of Add:


    Use this button to install the add-on and add the method.

Configuring Braintree Payment Gateway

To configure the Braintree Payment Gateway add-on, open the add-on settings page as follows:


If you don't have a Braintree account

Click on the Sign up for Braintree button:


A Braintree sign-up page will open in a new tab, where you can register with Braintree and create an account. Then, use your new Braintree account data for the payment setup.

If you already have a Braintree account

Fill in the settings page fields with your Braintree account data:

  • Merchant ID: Specify your Braintree account merchant ID in this field. The field is required.

  • Public key: Specify your Braintree account public key in this field. The field is required.

  • Private key: Specify your Braintree account public key in this field. The field is required.

  • Use Vault: The setting determines whether to save the credit card data or not. If set to "YES," X-Cart will automatically save the CC data for all customers.

  • Kount merchant ID: Specify your Kount merchant ID if you want to check the orders with the Kount antifraud services.

  • Google Pay merchant ID: Specify your Google Pay merchant ID if you want to give your customers an option to pay with Google Pay.

  • Test/Live mode: Use this setting to select the operation mode for your Braintree integration. Before you can offer a Braintree payment gateway on your website, you will first need to successfully carry out some required test transactions. To do the testing, you will need to set the operation mode of your integration to Test. You can switch the Test/Live mode setting to Live when the payment is ready for production use.

  • Auto settle: If you enable this option, your online store will automatically capture transactions when a customer places an order. Otherwise, you only get authorization on the payment method a customer selected at checkout but do not charge them until you fulfill the order. To assess the funds you have authorized, you need to manually capture the payment amount by clicking the Capture button on the details page of the respective order in your online store.

  • Braintree invoice number prefix: If you use the same account to accept payments from more than one X-Cart store, use this field to set an invoice number prefix for this store. The prefix will serve as an identifier of the store and help you avoid the "duplicate invoice number" type. Limit the length of the invoice prefix to 9 characters. Larger prefixes will be cut before transaction initialization.

  • Ask customers to save card in vault: If you enable this option, customers will see the "Save card for future orders in this shop" check-box at checkout and will be able to use it to save the credit card info. In the other case, there will be no check-box for customers at checkout, and whether the credit card data is saved or not will be determined by the Use Vault property.

  • Use 3-D Secure: If you enabled this option, X-Cart would conduct additional customer identity checks within the Braintree 3D Secure integration.

Click Save changes if you want to make the settings active.

Related pages:

Did this answer your question?