Repository files navigation

The Braintree gem provides integration access to the Braintree Gateway.

The Payment Card Industry (PCI) Council hasmandated that early versions of TLS be retired from service. All organizations that handle credit card information are required to comply with this standard. As part of this obligation, Braintree is updating its services to require TLS 1.2 for all HTTPS connections. Braintree will also require HTTP/1.1 for all connections. Please see ourtechnical documentation for more information.

geminstallbraintree

Or add to your Gemfile:

gem'braintree'

Optionally, you may also include Nokogiri for more performant XML parsing. If Nokogiri is not present, REXML will be used instead.The gem uses Nokogiri for XML parsing.

• builder
• nokogiri

The Braintree Ruby SDK is tested against Ruby versions 2.6, 2.7 and 3.0.

The Ruby core development community has releasedEnd-of-Life branches for Ruby versions lower than 2.6, which are no longer receiving security updates. As a result, Braintree no longer supports these versions of Ruby.We have updated our gem specifications to reflect these updates.

⚠️The SSL certificates for Ruby SDK versions older than 2.82.0 are set to expire by March 30, 2026. If you do not update your SDK to the latest version with the updated certificates by March 30, 2026, 100% of your impacted traffic will fail

Braintree employs a deprecation policy for our SDKs. For more information on the statuses of an SDK check ourdeveloper docs.Minimum supported versions are also available in our developer docs.

• Official documentation

Updating from an Inactive, Deprecated, or Unsupported version of this SDK? Check ourMigration Guide for tips.

require"rubygems"require"braintree"gateway=Braintree::Gateway.new(:environment=>:sandbox,:merchant_id=>"your_merchant_id",:public_key=>"your_public_key",:private_key=>"your_private_key",)result=gateway.transaction.sale(:amount=>"1000.00",:payment_method_nonce=>nonce_from_the_client,:options=>{:submit_for_settlement=>true})ifresult.success?puts"success!:#{result.transaction.id}"elsifresult.transactionputs"Error processing transaction:"puts"  code:#{result.transaction.processor_response_code}"puts"  text:#{result.transaction.processor_response_text}"elsepresult.errorsend

You retrieve yourmerchant_id,public_key, andprivate_key whensigning up for Braintree. Signing up for a sandbox account is easy, free, and instant.

Most methods have a bang and a non-bang version (e.g.gateway.customer.create andgateway.customer.create!).The non-bang version will either return aSuccessfulResult or anErrorResult. The bang version will either returnthe created or updated resource, or it will raise aValidationsFailed exception.

Example of using non-bang method:

result=gateway.customer.create(:first_name=>"Josh")ifresult.success?puts"Created customer#{result.customer.id}"elseputs"Validations failed"result.errors.for(:customer).eachdo |error|putserror.messageendend

Example of using bang method:

begincustomer=gateway.customer.create!(:first_name=>"Josh")puts"Created customer#{customer.id}"rescueBraintree::ValidationsFailedputs"Validations failed"end

We recommend using the bang methods when you assume that the data is valid and do not expect validations to fail.Otherwise, we recommend using the non-bang methods.

TheMakefile andDockerfile will build an image containing the dependencies and drop you to a terminal where you can run tests.

make

The Rakefile includes commands to runRubocop. To run the linter commands use rake:rake lint.

The unit specs can be run by anyone on any system, but the integration specs are meant to be run against a local developmentserver of our gateway code. These integration specs are not meant for public consumption and will likely fail if run onyour system. To run unit tests use rake:rake test:unit.

To suppress logs from Braintree on environments where they are considered noise(e.g. test) use the following configuration:

logger=Logger.new("/dev/null")logger.level=Logger::INFOgateway.config.logger=logger

See theLICENSE file for more info.