HomeProduct DocsAPI ReferenceChangelog
RecurlyAPI GuidesRecurly.jsWebhooksAPI ReferenceSupportBook demo
Product Docs

Braintree

Connect Braintree to Recurly to process credit cards, PayPal, Venmo, Apple Pay, and Google Pay — with multi-currency support and optional Braintree Vault storage.

Braintree is a full-stack payment platform with strong support for mobile and online transactions. Integrating it with Recurly lets you process cards, PayPal, Venmo, Apple Pay, and Google Pay — with multi-currency support via separate gateway instances for each currency.
Available on all Recurly plans

Limitations

  • Restricted business types — Braintree restricts its gateway to certain business models. If your business appears on Braintree's Acceptable Use Policy, you won't be able to use the Braintree gateway.
  • No lifecycle or post-auth webhooks — Recurly does not support lifecycle or post-auth webhooks from Braintree. If you're using gateway-level fraud review systems, gateway tokens, or processing transaction actions directly at the gateway, Recurly and Braintree can fall out of sync. Always capture, void, and process refunds from Recurly rather than directly in the gateway.
  • Dynamic descriptors — cards only — Dynamic descriptors are supported for Braintree, but only for card payments at this time.

Definition

Braintree is a full-stack payment platform that supports subscription billing, one-time payments, and a range of payment methods including cards, PayPal, Venmo, Apple Pay, and Google Pay. It integrates with Recurly via API credentials from your Braintree Control Panel. For multi-currency support, a separate Braintree gateway instance is required for each currency.

Key details

FeatureDetails
Services that work with RecurlySubscription billing, one-time payments, card dynamic descriptors, MOTO processing
Supported operationsAuthorize and Capture, Purchase, Refund, Void
Supported payment typesCredit/debit cards, PayPal, Venmo, Apple Pay, Google Pay
Supported card brandsVisa, Mastercard, Amex, Discover, JCB, Diners, Union Pay
Gateway-specific 3DS2 supportedYes
Card on file supportedYes
RegionsGlobal
CurrenciesMultiple (per merchant account ID) — see all available. PayPal transactions are limited to PayPal-supported currencies.
Additional feature supportBilling and shipping information, Level 2 data, Visa trial descriptors, Braintree gateway tokens, vaulting in Braintree, MOTO
Tip Before going live, see Recurly's guide to testing gateway configurations to verify your payment setup is working correctly.

Braintree and multi-currency

To accept multiple currencies through Braintree, configure a separate Braintree gateway instance in Recurly for each currency. Each instance requires your Merchant ID, Merchant Account ID, Public Key, and Private Key. The Merchant Account ID identifies which currency is enabled for that instance.

Processing PayPal through Braintree

You can process PayPal transactions through your Braintree merchant account. Make sure your Braintree account is configured to accept PayPal before enabling this in Recurly.

To initiate the PayPal one-touch checkout flow, use Recurly.js v4. Note that PayPal payment details displayed in Recurly Admin may look slightly different from other payment methods — this is because Recurly stores Braintree's vault token rather than the actual PayPal Billing Agreement, and uses that token for all subsequent PayPal transactions.

Processing Venmo through Braintree

See the Venmo payment method documentation for details.

Processing verifications with 3DS through Braintree

Braintree's standard verification route does not include 3DS capabilities unless you've integrated the Proactive 3D Secure route through Recurly.js. If you're a PSD2-mandated merchant in the EU, or require 3DS for risk purposes and want to process verifications rather than purchases, you'll need to use this integration path.

There are two mutually exclusive settings to configure — one requires Braintree's assistance:

Option 1 — Not vaulting with Braintree (Proactive 3DS without vaulting)

Contact your Braintree account manager to enable Verifications without Vaulting. This setting requires the holder of the card data to be PCI compliant. When requesting this feature, indicate that Recurly is storing the card data.

Once Braintree has enabled that setting, contact Recurly Support to enable the Braintree ZDA feature flag on the Recurly side. This flag unlocks the verification flow for 3DS — it does not disable 3DS through purchase routes.

Warning Do not enable the Braintree ZDA flag in Recurly before Braintree has enabled Verifications without Vaulting on their side — doing so will cause payment failures.

Option 2 — Vaulting with Braintree (Card Verification)

Enable Card Verification in your Braintree control panel to verify all cards before they enter the Braintree Vault.

Integrating Braintree with Recurly

Step 1: Gather your Braintree credentials

You'll need the following credentials from your Braintree Control Panel:

  • Merchant ID
  • Merchant Account ID (one per currency you intend to accept)
  • Public Key
  • Private Key

Step 2: Configure Braintree in Recurly

1

Open Payment Gateways

In Recurly, navigate to Configuration → Payment Gateways, click Add a Gateway, and select Braintree.

2

Enter your credentials

Input your Merchant ID, Public Key, and Private Key.

3

Add multi-currency gateways

For each additional currency, add a separate Braintree gateway instance using the corresponding Merchant Account ID.

4

Configure Zero Dollar Authorizations (ZDA)

Select the card types you want to enable for ZDA transactions. Visa, Mastercard, Discover, and Amex are supported. Note: enabling Amex ZDA sends a $0.01 authorization per Braintree's guidance.

5

Enable Braintree Vault (optional)

Check Store in Braintree Vault if you want to vault payment methods with Braintree.

6

Configure Visa free trial settings

If your Braintree merchant account is associated with Australia or Canada, select the appropriate country from the dropdown. For all other countries, select Other. If you're not running free trials, select None. See the Visa free trial mandate guide for details.

Step 3: Enable PayPal (optional)

Confirm your Braintree merchant account is configured to accept PayPal transactions — check your Braintree Control Panel or contact Braintree Support. No additional configuration is required in Recurly beyond the standard gateway setup.

Step 4: Test the configuration

1

Run a configuration test

In Recurly, go to Configuration → Payment Gateways → Braintree and click Test Configuration.

2

Review the results

A successful test confirms Recurly can communicate with Braintree and process transactions. Note that testing requires your Recurly account to be in development or production mode — sandbox mode is not supported for Braintree testing.

Step 5: Go live

1

Set Braintree to Production mode

In your Braintree account, confirm the environment is set to Production, not Sandbox.

2

Update the environment in Recurly

In your Recurly Braintree configuration, set the environment to Production and save your settings.

Tip After going live, monitor transactions regularly through the Recurly Admin interface or Braintree's Control Panel to keep your payment operations running smoothly.


Did this page help you?