Client SDK
Setup
Requirements
- Minimum supported Android API 23
- Requires Gradle JDK 17+
- Requires Kotlin 1.9.10+
- Requires Android Gradle Plugin 8.1.4+ (Giraffe or higher)
- Android API >= 21
It goes without saying, but we'll say it anyway: we always recommend using the latest versions of our SDKs.
Installation
There are several ways to include Braintree in your project, but Gradle is the preferred build system for working with the Braintree Android SDK.
Get the SDK
In your build.gradle
, add the dependencies for only the Braintree payment features you
wish to use:
- Kotlin
- Groovy
dependencies { // to offer card payments implementation("com.braintreepayments.api:card:5.2.0") // to collect device data implementation("com.braintreepayments.api:data-collector:5.2.0") // to offer PayPal implementation("com.braintreepayments.api:paypal:5.2.0") // to offer local payments implementation("com.braintreepayments.api:local-payment:5.2.0") // to offer Google Pay implementation("com.braintreepayments.api:google-pay:5.2.0") // to perform 3DS verification implementation("com.braintreepayments.api:three-d-secure:5.2.0") // to offer Venmo implementation("com.braintreepayments.api:venmo:5.2.0") }
- Kotlin
- Groovy
dependencies { // to offer card payments implementation("com.braintreepayments.api:card:4.49.1") // to collect device data implementation("com.braintreepayments.api:data-collector:4.49.1") // to offer PayPal implementation("com.braintreepayments.api:paypal:4.49.1") // to offer local payments implementation("com.braintreepayments.api:local-payment:4.49.1") // to offer Google Pay implementation("com.braintreepayments.api:google-pay:4.49.1") // to offer Union Pay implementation("com.braintreepayments.api:union-pay:4.49.1") // to perform 3DS verification implementation("com.braintreepayments.api:three-d-secure:4.49.1") // to offer Venmo implementation("com.braintreepayments.api:venmo:4.49.1") }
App Link setup
Some of our payment flows utilize App Links for returning from the payment experience back into your app. Follow the steps for setting up App Links.
Register App Link in Control Panel
Before using this feature, you must register your App Link domain in the Braintree Control Panel:
- Log into your Control Panel (e.g. Sandbox, or Production).
- Click on the gear icon in the top right corner. A drop-down menu will open.
- Select Account Settings from the drop-down menu.
- In the Processing Options tab, go to Payment Methods section.
-
Next to PayPal, click the Link Sandbox link. This will give
you option to link your Braintree and PayPal accounts.
- If your accounts are already linked, you'd see an Options button instead.
-
Click the View Domain Names button. This will take you to the
PayPal Domain Names page.
- Note: If you have a single PayPal account, it will be at the bottom of the page. If you have multiple PayPal accounts, it will be at the top right of the page.
- Click the + Add link on the top right of the page or scroll to the Specify Your Domain Names section.
-
In the text box enter your list of domain names separated by commas.
- Note: The value you enter must match your fully qualified domain name exactly – including the "www." if applicable.
- Click the Add Domain Names button.
- If the domain registration was successful for all the domain names listed in the text box, a banner will display the text "Successfully added domains". The registered domain names will be displayed in alphabetical order under the + Add button.
-
If the registration was not successful for any of the domain names listed in the text box, a
banner will display a list of domain names that failed qualified domain name validation along
with their reasons for rejection. Any domain names that were successfully registered will be
displayed in alphabetical order under the + Add button.
- Note: You can re-enter the rejected domain names in the text area with the corrections applied.
Set App Link in SDK
Pass your App Link to the Client constructor (this example is using creating a PayPalClient):
- Kotlin
val payPalClient = PayPalClient( context = this, authorization = "[TOKENIZATION_KEY]", appLinkReturnUrl = Uri.parse("https://merchant-app.com") // Merchant App Link )
intent-filter
to your AndroidManifest.xml file:
- Xml
<intent-filter android:autoVerify="true"> <action android:name="android.intent.action.VIEW" /> <category android:name="android.intent.category.DEFAULT" /> <category android:name="android.intent.category.BROWSABLE" /> <data android:scheme="https" /> <data android:host="merchant-app.com"/> <!-- required if your app link contains a path --> <data android:pathPrefix="/path" /> </intent-filter>
.
Browser switch setup
Some of our payment flows utilize a browser switch. A URL scheme must be defined to return to your
app from the browser. Edit your
AndroidManifest.xml
to include an intent-filter
and set the
android:scheme
on your Activity that will be responsible for handling the deep link
back into the app:
- Xml
<activity android:name="com.company.MyActivity" android:exported="true"> <intent-filter> <action android:name="android.intent.action.VIEW" /> <category android:name="android.intent.category.DEFAULT" /> <category android:name="android.intent.category.BROWSABLE" /> <data android:scheme="\${applicationId}.braintree" /> </intent-filter> </activity>
android:exported
attribute is required if your app compile SDK version is API 31
(Android 12) or later.
.braintree
. For example, if the Package ID is com.your-company.your-app
,
then your URL scheme should be com.your-company.your-app.braintree
.
${applicationId}
is automatically applied with your app's package when using Gradle.
DropInActivity
already uses the ${applicationId}.braintree
url
intent filter. If your app has multiple browser switch targets, you can specify multiple intent
filters and use the BraintreeClient
constructor that allows you to specify a
customUrlScheme
:
- Xml
<activity android:name="com.company.app.MyPaymentsActivity1" android:exported="true"> ... <intent-filter> <action android:name="android.intent.action.VIEW"/> <data android:scheme="custom-url-scheme-1"/> <category android:name="android.intent.category.DEFAULT"/> <category android:name="android.intent.category.BROWSABLE"/> </intent-filter> </activity> <activity android:name="com.company.app.MyPaymentsActivity2" android:exported="true"> ... <intent-filter> <action android:name="android.intent.action.VIEW"/> <data android:scheme="custom-url-scheme-2"/> <category android:name="android.intent.category.DEFAULT"/> <category android:name="android.intent.category.BROWSABLE"/> </intent-filter> </activity>
BraintreeClient
make sure to pass the appropriate custom
url scheme for each deep link target Activity:
- Kotlin
- Java
// MyPaymentsActivity1.kt val braintreeClient1 = BraintreeClient(this, "TOKENIZATION_KEY_OR_CLIENT_TOKEN", "custom-url-scheme-1") // MyPaymentsActivity1.kt val braintreeClient2 = BraintreeClient(this, "TOKENIZATION_KEY_OR_CLIENT_TOKEN", "custom-url-scheme-2")
Initialization
Each payment method type requires
authorization in the form of a
Tokenization Key or Client Token. Each payment method type has its own feature client. To initialize
any of the feature clients, first instantiate a BraintreeClient
:
Authorization
A
tokenization key
can be passed to the payment method Client class constructors. The example below shows a
PayPalClient
initialization with a tokenization key authorization:
- Kotlin
val payPalClient = PayPalClient( context = this, authorization = "[TOKENIZATION_KEY]", appLinkReturnUrl = Uri.parse("https://merchant-app.com") // Merchant App Link )
BraintreeClient
. When constructing a BraintreeClient
, you can provide a
tokenization key
or a ClientTokenProvider
for
client token
authorization. When given a ClientTokenProvider
, the SDK will fetch a client token on
your behalf when it is needed. This makes it possible to construct a
BraintreeClient
instance using client token authorization in onCreate
. The
example below shows the initialization with a tokenization key authorization:
- Kotlin
- Java
class MyActivity : AppCompatActivity() { private lateinit var braintreeClient: BraintreeClient override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) braintreeClient = BraintreeClient(this, "<#TOKENIZATION_KEY#>") } }
Client Token Provider
Below is an example of ClientTokenProvider
implementation using
Retrofit 2.x. This example assumes that you have a
server that supports GET
https://www.my-api.com/client_token
and receives
the following json response:
- JSON
{ "value": "<client_token>" }
- Kotlin
- Java
// In ClientToken.kt file taht you create class ClientToken { val value = null } // In Api.kt file that you create interface Api { @GET("/client_token") fun getClientToken(): Call<clienttoken> } // In ExampleClientTokenProvider.kt file that you create internal class ExampleClientTokenProvider : ClientTokenProvider { override fun getClientToken(callback: ClientTokenCallback) { val call: Call<clienttoken> = createService().getClientToken() call.enqueue(object : Callback<clienttoken?> { override fun onResponse(call: Call<clienttoken?>?, response: Response<clienttoken?>?) { response?.body()?.value?.let { callback.onSuccess(it) } } override fun onFailure(call: Call<clienttoken?>?, t: Throwable?) { callback.onFailure(Exception(t)) } }) } companion object { private val builder = Retrofit.Builder() .baseUrl("https://my-api.com") .addConverterFactory(GsonConverterFactory.create()) private val httpClient = OkHttpClient.Builder() fun createService(): Api { builder.client(httpClient.build()) val retrofit = builder.build() return retrofit.create(Api::class.java) } } }
PayPalClient
initialization with a Client Token:
- Kotlin
val payPalClient = PayPalClient( context = this, authorization = "[CLIENT_TOKEN]", appLinkReturnUrl = Uri.parse("https://merchant-app.com") // Merchant App Link )
BraintreeClient
using your ClientTokenProvider
:
- Kotlin
- Java
class ExampleActivity : AppCompatActivity() { private lateinit var braintreeClient: BraintreeClient override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) braintreeClient = BraintreeClient(this, ExampleClientTokenProvider()) } }
ProGuard
A ProGuard configuration is provided as part of the Braintree Android SDK. There is no need to add
any Braintree specific rules to your ProGuard configuration.