Braintree Android Drop-In
Braintree Android Drop-In is a readymade UI that allows you to accept card and alternative payments in your Android app.
Adding it to your project
Add the dependency in your build.gradle:
dependencies {
implementation 'com.braintreepayments.api:drop-in:6.0.1'
}
Additionally, add the following Maven repository and (non-sensitive) credentials to your app-level gradle:
repositories {
maven {
url "https://cardinalcommerceprod.jfrog.io/artifactory/android"
credentials {
username 'braintree_team_sdk'
password 'AKCp8jQcoDy2hxSWhDAUQKXLDPDx6NYRkqrgFLRc3qDrayg6rrCbJpsKKyMwaykVL8FWusJpp'
}
}
}
Versions
This SDK abides by our Client SDK Deprecation Policy. For more information on the potential statuses of an SDK, check our developer docs.
| Major version number | Status | Released | Deprecated | Unsupported |
|---|---|---|---|---|
| 6.x.x | Active | November 2021 | TBA | TBA |
| 5.x.x | Inactive | September 2020 | November 2022 | November 2023 |
| 4.x.x | Deprecated | February 2019 | September 2021 | September 2022 |
Versions 3 and below are unsupported.
Usage
Create a DropInRequest to start the Drop-in UI with specified options:
val dropInRequest = DropInRequest()
DropInClient is responsible for launching the Drop-in UI. To launch Drop-in, instantiate a DropInClient with client authorization and call DropInClient#launchDropInForResult with the DropInRequest you configured above and a request code that you have defined for Drop-in:
val dropInClient = DropInClient(this, "<#CLIENT_AUTHORIZATION#>", dropInRequest)
dropInClient.launchDropInForResult(this, DROP_IN_REQUEST_CODE)
To handle the result of the Drop-in flow, override onActivityResult:
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
super.onActivityResult(requestCode, resultCode, data)
if (requestCode == DROP_IN_REQUEST_CODE) {
if (resultCode == RESULT_OK) {
val result: DropInResult? = data?.getParcelableExtra(DropInResult.EXTRA_DROP_IN_RESULT)
val paymentMethodNonce = result?.paymentMethodNonce?.string
// use the result to update your UI and send the payment method nonce to your server
} else if (resultCode == RESULT_CANCELED) {
// the user canceled
} else {
// an error occurred, checked the returned exception
val error: Exception? = data?.getSerializableExtra(DropInResult.EXTRA_ERROR) as? Exception
}
}
}
Localization
Drop-In is currently localized for 25 languages. To view localized text for a specific locale, open its corresponding values-<LOCALE_NAME>/strings.xml resource file.
3D Secure + Drop-in
Drop-In supports 3D-Secure verification. Assuming you have 3D-Secure configured for your account, create a ThreeDSecureRequest() object, setting ThreeDSecurePostalAddress and ThreeDSecureAdditionalInformation fields where possible; the more fields that are set, the less likely a user will be presented with a challenge. For more information, check our 3D Secure Migration Guide. Make sure to attach this object to the BTDropInRequest before use.
val address = ThreeDSecurePostalAddress()
address.givenName = "Jill" // ASCII-printable characters required, else will throw a validation error
address.surname = "Doe" // ASCII-printable characters required, else will throw a validation error
address.phoneNumber = "5551234567"
address.streetAddress = "555 Smith St"
address.extendedAddress = "#2"
address.locality = "Chicago"
address.region = "IL"
address.postalCode = "12345"
address.countryCodeAlpha2 = "US"
// Optional additional information.
// For best results, provide as many additional elements as possible.
val additionalInformation = ThreeDSecureAdditionalInformation()
additionalInformation.shippingAddress = address
val threeDSecureRequest = ThreeDSecureRequest()
threeDSecureRequest.amount = "1.00"
threeDSecureRequest.email = "[email protected]"
threeDSecureRequest.billingAddress = address
threeDSecureRequest.versionRequested = VERSION_2
threeDSecureRequest.additionalInformation = additionalInformation
val dropInRequest = DropInRequest()
dropInRequest.threeDSecureRequest = threeDSecureRequest
Fetch last used payment method
If your user already has an existing payment method, you may not need to show Drop-in. You can check if they have an existing payment method using DropInClient#fetchMostRecentPaymentMethod. A payment method will only be returned when using a client token created with a customer_id.
val dropInClient = DropInClient(this, "<#CLIENT_TOKEN_WITH_CUSTOMER_ID>", dropInRequest)
dropInClient.fetchMostRecentPaymentMethod(this) { dropInResult, error ->
error?.let {
// an error occurred
}
dropInResult?.let { result ->
result.paymentMethodType?.let { paymentMethodType ->
// use the icon and name to show in your UI
val icon = paymentMethodType.drawable
val name = paymentMethodType.localizedName
if (paymentMethodType == DropInPaymentMethod.GOOGLE_PAY) {
// The last payment method the user used was Google Pay.
// The Google Pay flow will need to be performed by the
// user again at the time of checkout.
} else {
// Show the payment method in your UI and charge the user
// at the time of checkout.
val paymentMethod = result.paymentMethodNonce
}
}
} ?: run {
// there was no existing payment method
}
}
Help
- Read the javadocs
- Read the docs
- Find a bug? Open an issue
- Want to contribute? Check out contributing guidelines and submit a pull request.
Feedback
Here are a few ways to get in touch:
- GitHub Issues - For generally applicable issues and feedback
- Braintree Support / Get Help - for personal support at any phase of integration
License
Braintree Android Drop-In is open source and available under the MIT license. See the LICENSE file for more info.
0 Nov 25, 2022
10 Dec 15, 2022
3 Oct 27, 2022
976 Dec 29, 2022
648 Dec 23, 2022
659 May 14, 2022
424 Dec 9, 2022
219 Nov 25, 2022
235 Dec 2, 2022
17 Nov 12, 2021
1.8k Dec 30, 2022
62 Dec 18, 2022
30 Nov 16, 2022
3 Oct 26, 2021
31 Dec 13, 2022
6 Jan 8, 2022
1 Oct 13, 2021
2 Aug 10, 2022