Braintree

Braintree is a PayPal service that helps businesses of all sizes to accept payments and process payments, while enjoying Braintree's innovative technology and white-glove support backed by one of the world's most trusted and established fintech brands.

Setting Up Braintree

There are several different identifiers associated with your Braintree account. Here are some important ones you'll need to know.

Merchant ID

Your merchant ID is the unique identifier for your entire gateway account, including the multiple merchant accounts that may be in your gateway. Often referred to as the public ID or production ID, your merchant ID will be different for your production and sandbox gateways. If you contact their support team for assistance, they may ask you to confirm this credential for your gateway account.

To find your merchant ID:

1. Log into either the production Control Panel or the sandbox Control Panel, depending on which environment you are working in.
2. Navigate to Account > Merchant Account Info.

You'll find your merchant ID at the top of this page. Your merchant ID can also be found when logged into your Control Panel, as the string of letters and numbers following /merchants/ in the URL.

Merchant account ID

A single Braintree gateway can have multiple merchant accounts to process transactions for different businesses or currencies. Each merchant account within a gateway can be identified by its unique merchant account ID.

To find your merchant account ID(s):

1. Log into either the production Control Panel or the sandbox Control Panel, depending on which environment you are working in.
2. Navigate to Account > Merchant Account Info.
3. Scroll down to the Merchant Account section.

You'll see the merchant account IDs in the first column for each account.

Public key

This is your user-specific public identifier. Each user associated with your Braintree gateway will have their own public key.

1. Log into either the production Control Panel or the sandbox Control Panel, depending on which environment you are working in.
2. Navigate to Settings > API Keys.

You'll find your public key under the API Keys section at the top. If no API keys appear, click Generate New API Key.

Private key

This is your user-specific private identifier. Each user associated with your Braintree gateway will have their own private key. Your private key should not be shared outside the use of an API call – even with us. To find your private key:

1. Log into either the production Control Panel or the sandbox Control Panel, depending on which environment you are working in.
2. Navigate to Settings > API Keys.
3. In the API Keys section, click View under the Private Key column.

Your private key will be revealed in the Private Key column on the next page.

Recurring Plan

With Braintree's recurring billing, you can charge your customers automatically in monthly increments. In order to set this up, you'll need to create a plan in the Control Panel and store your customers in the Vault. From there, you can associate each customer's preferred payment method with a plan to create a subscription.

You can only create plans in the Control Panel. To create a plan:

1. Log into the Control Panel.
2. Under Recurring Billing, click Plans.
3. Click Create a plan*.
4. Once you've filled out all of the relative information – including choosing the billing date, the number of billing cycles, any add-ons/discounts, or trial periods – click Create.

If you have already created one or more plans, this button will read New.

Webhooks Notification

PayPlans utilizes webhooks to send notifications. Webhooks is a system of automated notifications indicating that an event has occurred in your gateway. In order to configure webhooks, your user’s role must include the Manage Webhooks role permission.

To create a webhook:

1. Log into the Control Panel.
2. Navigate to Settings > Webhooks.
3. Click Create New Webhook.
4. Provide your destination URL.
   http://yoursite.com/index.php?option=com_payplans&view=payment&task=notify&gateway=braintree
5. Select which kind of webhook you'd like to create. Example: subscription went active, subscription charged successfully etc.
6. Click Create Webhook.

Braintree Configuration

The General options for Braintree are fairly the same among all payment methods. You'll need to give a suitable title, determine whether to be published or unpublished and the appropriate description for this payment method. You may set this payment method to be applied on all plans or only on selected plans.

The following screenshot illustrate the options available in Braintree.

The Parameters section are the specific options needed when configuring Braintree integration. Details of each options are described below.

• Merchant ID : Your Merchant ID is a unique identifier for your entire gateway account.

• Secondary Merchant ID : Secondary Merchant ID is actually your Merchant Account ID. The merchant account ID is a unique identifier for a specific merchant account in your gateway, and is used to specify which merchant account to use when creating a transaction.

• Public Key : Enter the public key generated by Braintree.

• Private Key : Enter the private key generated by Braintree.

• Recurring Plan ID : Enter the Recurring Plan ID which was created on Braintree.

• Allow Recurring Billing Cancellation : This option allows users to cancel their recurring billing on the front end when they are viewing their purchases.

• Test Mode : This option is used in development phase. Always set to No when in the production.

When everything is in order, click on the Save button to store the configuration.

Merchant Account ID vs Merchant ID

While merchant account ID and merchant ID sound familiar, they are actually different values with distinct purposes, and are often confused with one another.

Your Merchant ID is a unique identifier for your entire gateway account and one of the four API credentials. This value is required for certain actions, such as connecting your API calls to Braintree gateway or setting up third-party shopping carts.

Your Merchant Account ID is a unique identifier for a specific merchant account in your gateway. It is used to specify which merchant account to use when creating a transaction, creating a subscription, verifying a payment method, or generating a client token.