Redeem Now
Read More
Read now
Menu Close
    Start a Project Request quote Reading list Switch to dark mode

    Magento 2 Braintree Payment Gateway Marketplace Add-on

    Magento 2 Braintree Payment Gateway Marketplace Add-on allows the seller to add Braintree Payment Gateway for their products. This module simplifies the payment process for the online Magento store.

    Meanwhile, using this module customers can do the transaction with a reliable and secure payment gateway. It will provide an easy refund process for its customers.

    Further, the admin and the seller both can refund the invoice amount. And both have the option to partially refund the amount as well.

    Note : Online refund by seller and admin will be applicable when the transaction status is “Settled”.

    This module is an add-on of Magento2 Marketplace Module. To use this module you must have installed first Magento2 Marketplace.


    • Allow all types of cards supported by the Braintree.
    • Latest Braintree Drop-in UI used for the checkout page.
    • Fully PCI Compliant, no card details submitted to the client’s server.
    • The admin can enable vault to store card details.
    • Customers can re-use card details if saved in the vault.
    • The admin can enable escrow seller funds to release in the future.
    • Admin can set to release escrow amount automatically (using cron, will execute daily at 1 am).
    • The admin can define when to release escrow amount in the number of days.
    • The admin can also manually release an escrowed amount for a particular transaction in the order.
    • Admin can refund the invoice amount.
    • The admin can partially refund the invoice amount.
    • Enable/disable payment method from the admin panel.
    • The seller can refund Braintree transactions online.
    • The seller can also partially refund the order.
    • The payment automatically splits to sellers at the time of checkout
    • The seller can become sub-merchant by providing details, and able to receive funds if payment is done by Marketplace Braintree Payment Method.
    • Braintree uses webhooks to check the sub-merchant status and update the seller accordingly and to inform the seller about transaction disbursement, cancel, or any dispute.


    Moreover, the customers will get a zip folder and they have to extract the contents of this zip folder on their system.

    Meanwhile, the extracted folder has an src folder, inside the src folder you have the app folder. You need to transfer this app folder into the Magento2 root directory on the server as shown below.

    After the successful installation, you have to run these commands in the Magento2 root directory:

    First command –

    Second Command –

    Third Command –

    After running the commands, you have to flush the cache from the Magento admin panel by navigating through->System->Cache management as shown below.

    Configuration For Multi-Lingual Support

    Further, for the multilingual support, the admin will navigate through Store->Configuration->General ->Locale Options and select the locale as German (the language into which admin want to translate his store content).


    Meanwhile, if a user wants to translate their module from English to German then they need to follow the path app/code/Webkul/MpBraintree/i18n in their unzipped folder and will get a CSV file with name “en_US.csv”.

    Now they will rename that CSV as “de_DE.csv” and translate all right side content after the comma in the German language. After editing the CSV, save it and then upload it to the path app/code/Webkul/MpBraintree/i18n where they have installed Magento2 on the server.

    The module will get translated into the German Language. It supports both RTL and LTR languages.

    The user can edit the CSV like the image below.

    How To Get The API Credentials

    To generate the API credentials fro sandbox account, the user can click on the link:

    Login to the production account via link:

    In case the user do not have any account, then they can click on the signup button present in the top right corner. This will be present in the sandbox account. The sign up form is shown in the image below:

    After completing the login process, the user can now see the Homepage. Further, under the Settings icon the customer will click on the API option.

    Moreover, this will redirect the customer to the API keys page, where the user can see the API Keys, Tokenization Keys, etc. The list will be visible with the previously created keys as shown in the image below:

    By clicking on the View button under the Private Key tab of API Keys, the user can check the private keys too. They will be visible as shown in the image below:

    The user can also generate the new credentials by clicking on the Generate new API Key button. After that a popup will appear as shown in the image below:

    The user can also generate the new tokenization credentials by clicking on the Generate Tokenization API Key button. After that a popup will appear as shown in the image below:

    Generate Merchant Account

    For checking/ generating the merchant ID, the user can again click on the setting icon and choose the OAuth tab as shown in the image below:

    Further, the users needs to click on the Business tab present in the top of the page. There the user can check the Merchant ID as shown in the image below:

    Moreover, the user can create new credentials by clicking on the New Sandbox Merchant Account button. After that, a form will appear as shown in the image below:

    The customer can create the new credentials by providing the Merchant Account ID.


    After the successful installation of the Marketplace Braintree For Magento2 the admin of the marketplace can configure the plugin.

    Furthermore, the configuration will be done under “Stores > Configuration > Sales > Payment Methods > Marketplace Braintree Payment Gateway” as per the below snapshot. 

    Enabled – Select “Yes” if you want to enable the module. Else select “No”.

    Title – Enter the name of the payment method as it will appear in the Payment Information list.

    Environment – Here the admin can select the environment of Braintree. Whether it is “Sandbox” or “Production”  as per the requirement.

    Account Id – Here the admin will enter the Account Id which is provided by Braintree Payment Gateway.

    Merchant Id –  This option sets the Merchant Id which is provided by Braintree Payment Gateway.

    Public Key – Here the admin will enter the Public Key which is provided by Braintree Payment Gateway.

    Private Key –  Here the admin will enter the Private which is provided by Braintree Payment Gateway.

    Tokenization Key – Here admin enter the Tokenization Key collected from the Braintree.

    Payment from Applicable Countries – Select which customers can use this payment method. All Allowed Countries means all customers from the default countries list can use this payment method. Admin can also select the payment method for the specified country.

    Minimum Order Total – This option allows admin to set minimum order total.

    Moreover, if the Grand total of an order is less than the specified Minimum Order Total value then the Braintree module will not allow to check out with the Braintree payment gateway.

    Maximum Order Total – This option allows admin to set maximum order total.

    Sort Order – Admin can enter the sort order. This will determine in what order each method is listed in the front-end.

    Terms Of Services Link – Link of terms of services.

    Vault Enabled – If this option is set as yes then buyer information will be saved in Braintree Otherwise buyer information will not be saved in Braintree. Therefore, please check the below image for a better understanding.

    Escrow Settings :

    Hold In Escrow –  Using this option admin can enable or disable Hold in Escrow setting. if hold in escrow is enabled then money is distributed to the seller but it will be on hold, when admin will release that money then the seller will get the money.

    Otherwise, money will be sent directly to sellers.

    Auto Release –  It depends on cron. If cron is active amount will be released automatically. Else release amount manually.

    Release amount from escrow after days –

    Enter days after which amount will be released from escrow.

    Note- The admin can’t hold funds in escrow for longer than 30 days according to Braintree escrow guidelines.

    Therefore, all the keys will be collected from the Braintree. Admin can find the same under “Account > My User > API Keys, Tokenization Keys, Encryption Keys > View Authorizations “.

    Working Process

    Moreover, if any customer wants to become a sub-merchant seller then he/she has to enter their Business Information and Funding Information under “Braintree Vendor Details”. Refer to the screenshot for the same.

    Further, if the seller wants to register as a business then he needs to check the “Register as a business” checkbox to provide the business details. After that, the form will be updated as below image and the seller can provide business details as well.

    On top, the seller can see the payment method environment whether it is “Sandbox” or “Live”. In the Sandbox, some fields are prefilled as Braintree do not accept random data in Sandbox mode.

    Furthermore, if Magento Braintree Payment Gateway Method is enabled from the admin panel then the buyer can see this payment method inside his “Payment Information” as shown in the given screenshot.

    Admin Management

    Also, the admin can see the transaction list in Braintree account under “Transactions”.

    After that, the admin can find all transaction details of Marketplace Braintree transfer for a placed order, as shown in the below screenshot under “Transactions”.

    Moreover, by clicking on a transaction the admin can find complete details of that transaction as well.

    Marketplace Braintree Refund Management

    Seller End Refund Management

    Likewise, the seller can do an online refund with the help of the Magento Marketplace Braintree Payment method.

    Moreover, the seller can generate a credit memo and can enter the Adjustment fee, Adjustment shipping, and can even refund shipping as well.

    Admin End Refund Management

    Further, the admin can refund an order by clicking on “Credit Memo”.

    Moreover, the admin can generate a credit memo and can enter the Adjustment fee, Adjustment shipping, and can even refund shipping as well.

    Webhooks In Marketplace Braintree

    Firstly, webhooks are real-time notifications that alert you whenever an automated event occurs in our system.

    Moreover, the Magento Braintree Payment Gateway provides Webhook i.e “Sub-merchant account approved, Sub-merchant account declined, Transaction disbursed, Disbursement, Disbursement exception, Dispute opened, Dispute lost, Dispute won”.

    Transaction disbursed, Disbursement, Disbursement exception– With these Webhooks, there is added an appropriate comment on the order.

    Dispute opened, Dispute lost, Dispute won– Using “Dispute opened, Dispute lost, Dispute won”, transaction status will be automatically updated on Magento store.

    Sub-merchant account approved, Sub-merchant account declined– Whenever any Braintree sub-merchant is created or updated then using “Sub-merchant account approved, Sub-merchant account declined” webhook notification, the seller will be updated automatically if sub-merchant is declined the seller will become a default user.

    How to create Webhooks

    Further, from the Braintree Account navigate to “Settings > Webhooks” to view your webhooks.

    After that, click on “Create New Webhook” to create a new Webhook.

    That’s all for the Magento 2 Braintree Payment Gateway Marketplace Add-on, still have any issue, feel free to add a ticket and let us know your views to make the plugin better at

    Current Product Version - 3.0.0

    Supported Framework Version - Magento 2.0.x, 2.1.x, 2.2.x,2.3.x, 2.4.x

    . . .

    Leave a Comment

    Your email address will not be published. Required fields are marked*

    Be the first to comment.

    Back to Top
    Hire Us!
    Brief us about your requirements and we'll get back to you.
    Woo! Hooy!
    We have just recieved your project brief and our expert will contact you shortly.
    Send Again

    Table of Content

    Hide Index