Reading list Switch to dark mode

    Magento Braintree Payment Gateway

    Updated 2 May 2019

    With the help of this module, admin can now add Braintree Payment Gateway for their product. Now you can do transaction with the reliable and trusted payment gateway. Braintree provides eCommerce businesses with the ability to accept payments online.


    • Allow activating cron job using C panel for automatic capture invoice on transaction settled.
    • Online void transaction on Cancel and Void order from admin panel.
    • Separate Braintree transaction order grid.
    • Use Merchant Account ID which helps in using the multi-currency feature for the admin.
    • Webhook notification to update braintree order comment status on braintree transaction i.e DISBURSEMENT_EXCEPTION, DISBURSEMENT, TRANSACTION_DISBURSED, Transaction_DISPUTE_OPENED, Transaction_DISPUTE_WON, Transaction_DISPUTE_LOST
    • Admin can enable vault to store the information.
    • Enable/disable payment method from the admin panel.
    • Ability to Refund if the invoice has been generated.


    Installation of Magento Braintree Payment module is very simple. You just need to move app, wkbraintreecron and lib folder into Magento root. Please follow the screenshots for the same.


    After moving both the folder flush the cache from Magento admin module. Under System > Cache management.


    Searching for an experienced
    Magento Company ?
    Find out More

    And now your Magento Braintree Payment Gateway module has been installed.


    After the successful installation of the Braintree Payment Gateway module you will be able to see the configuration panel under System > Configuration > Sales > Payment Methods > Webkul Braintree Payment Gateway as per the below screen.

    Configuration System Magento Admin


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

    SandBox Active

    Here admin can check Braintree payment using sandbox mode to set “Yes”, if selected option is “No” option then production mode is enabled.


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

    Merchant Id

    This option sets the Merchant Id which is provided by Braintree Payment Gateway. Merchant ID is a unique identifier for your entire gateway account. This value is required for certain actions, such as connecting your API calls to the Braintree gateway or setting up third-party shopping carts.

    Merchant Account ID

    Here the admin will enter the Account Id which is provided by Braintree Payment Gateway which will help the admin to use multi-currency. It is used to specify which merchant account to use when creating a transaction, creating a subscription or verifying a payment method.

    Private Key

    This option sets the Private key which will use for testing the payment gateway.

    Public Key

    This option sets the Public key which will use for testing the payment gateway.

    Enable Vault

    If this option is set as yes then customer information will be saved. Otherwise, customer information will not save.

    Payment For 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.

    New Order Status

    This option determines the order status at the completion of checkout. Admin can set Pending or Processing order status.

    Minimum Order Total

    This option allows admin to set minimum order total. If Grand total of an order is less than specified Minimum Order Total value then Braintree module will not allow to checkout with 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.

    As you can see Public Key and Private Key in below screenshot. Braintree Payment Gateway will provide you these keys.


    Magento Braintree Payment Gateway Working Process

    If Magento Braintree Payment Gateway Method is enabled from admin panel then the buyer can see this payment method inside his “Payment Information” as shown in the given screenshot. Our Braintree Payment Gateway is based on Drop-In UI which includes the card entry form too.


    Now after selecting the Braintree Payment Gateway, a new pop for entering card detail will appear, where the customer will enter the card detail.

    On successful entry of details, a message will appear of card applied will appear. After this, the customer can place the order.

    Checkout (1)

    After successful checkout, the amount will pay to Braintree account of admin and if the vault is enabled then that customer information will store in the vault.

    Admin Management

    Admin can see the list of all transaction under Braintree Management > Manage Braintree Order.


    If the Braintree Transaction Status is Authorized or Submitted For Settlement, then invoice status will be in the pending state. With this transaction status, admin can void or cancel the transaction as well as on this action void will occur for the transaction. Admin can see the transaction list in Braintree account.


    Online Cancel/Void Order

    Admin can void or cancel the order by clicking on order id. Refer to the below screenshot for the same.


    If the Braintree transaction status is Settling or Settled, then invoice will be generated and Invoice status becomes captured. If cron job is activated then invoice will be captured automatically on “Settled” transaction. Admin can also capture the invoice manually.

    Order detail for Settled transaction


    Braintree Money Refund For an Order

    When invoice will generate, admin can refund the money. Follow these steps to Refund money.

    1. Go to invoice page for a placed order for which wanna do a refund. Now click on the “Credit Memo” tab.


    2. After clicking on Credit Memo, you have to click on Refund button. Refer to the below screenshot for the same.


    Braintree will refund when transaction status is settled.


    After successful Refund, you can see the Refund transaction detail in Braintree Account.


    Webhooks In Braintree

    Webhooks are real-time notifications that alert you whenever an automated event occurs in our system. Magento Braintree Payment Gateway provides Webhook notification to update braintree order comment status on braintree transaction i.e DISBURSEMENT_EXCEPTION, DISBURSEMENT, TRANSACTION_DISBURSED, Transaction_DISPUTE_OPENED, Transaction_DISPUTE_WON, Transaction_DISPUTE_LOST

    How to create Webhooks

    From your Braintree Account navigate to Settings > Webhooks and create your webhooks.


    That’s all for the Magento Braintree Payment Gateway module, still have any issue feel free to add a ticket and let us know your views to make the module better

    Current Product Version - 1.0.1

    Supported Framework Version - 1.6.x.x , 1.7.x.x , 1.8.x.x , 1.9.x.x

    . . .

    Leave a Comment

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


  • frank
    • Rajan Dimri (Moderator)
  • A
    • Zeba Hakim (Moderator)
  • merchant account services
    • webkul
  • Back to Top

    Message Sent!

    If you have more details or questions, you can reply to the received confirmation email.

    Back to Home

    Table of Content