Awesome

Braintree Android SDK

Welcome to Braintree's Android SDK. This library will help you accept card and alternative payments in your Android app.

:mega:  A new major version of the SDK is now available. See the v5 migration guide for details.

The Braintree SDK supports Android API 23 and above.

The Braintree SDK requires Java 17 and uses Kotlin 1.9.10.

📣 Announcements

Upgrade your integration to continue accepting Braintree payments The SSL certificates for the Android SDK are set to expire by June 31, 2025. Upgrade to v4.45.0+ to continue using the Braintree SDK.

Adding It To Your Project

The features of the Braintree SDK are organized into modules that can be imported as dependencies in your build.gradle file. See the Migration Guide for specific dependencies required for each module.

For an integration offering card payments, add the following dependency in your build.gradle:

dependencies {
  implementation 'com.braintreepayments.api:card:5.2.0'
}

To preview the latest work in progress builds, add the following SNAPSHOT dependency in your build.gradle:

dependencies {
  implementation 'com.braintreepayments.api:card:5.0.0-beta2-SNAPSHOT'
}

You will also need to add the Sonatype snapshots repo to your top-level build.gradle to import SNAPSHOT builds:

allprojects {
    repositories {
        maven {
            url 'https://oss.sonatype.org/content/repositories/snapshots/'
        }
    }
}

Documentation

Start with 'Hello, Client!' for instructions on basic setup and usage.

Next, read the full documentation for information about integration options, such as Drop-In UI, PayPal and credit card tokenization.

Upgrade Your SDK Version

We always recommend updating to the latest version of the SDK which can be found in our CHANGELOG.

For major version upgrades, feel free to check out the MIGRATION GUIDE.

For more details on how to add and managed build dependencies, see the Android Developer Guidelines.

Versions

This SDK abides by our Client SDK Deprecation Policy. For more information on the potential statuses of an SDK check our developer docs.

Versions 3.x.x and below are unsupported.

Help

• Read the docs
• Check out the reference docs
• Find a bug? Open an issue
• Want to contribute? Check out contributing guidelines and submit a pull request.

Feedback

The Braintree Android SDK is in active development. We welcome your feedback!

Here are a few ways to get in touch:

• GitHub Issues - For generally applicable issues and feedback
• Braintree Support / support@braintreepayments.com - for personal support at any phase of integration

License

The Braintree Android SDK is open source and available under the MIT license. See the LICENSE file for more info.