Client-Side Implementation

Important

The SSL certificates for Braintree Mobile (iOS and Android) SDKs are set to expire on March 30, 2026. This will impact existing versions of the SDK in published versions of your app. To reduce the impact, upgrade the iOS SDK to version 6.17.0+Android SDK to version 4.45.0+ or version 5.0.0+ for the new SSL certifications.

If you do not decommission your app versions that include the older SDK versions or force upgrade your app with the updated certificates by the expiration date, 100% of your customer traffic will fail.

Collecting device data

BraintreeDataCollector enables you to collect data about a customer's device and correlate it with a session identifier on your server.

Get the SDK

CocoaPods

Include Braintree/DataCollector in your Podfile:

Ruby

# Podfile
pod 'Braintree/DataCollector'

Swift Package Manager

Include the BraintreeDataCollector framework.

Carthage

Include the BraintreeDataCollector and PPRiskMagnes frameworks.

Implementation

BraintreeDataCollector collects data about a customer's device and returns a device_data string that contains one or more identifiers that correlate with the collected data. Collecting and passing this data with transactions helps reduce decline rates.

Before making a request to your server, get the device data string by intializing a BTDataCollector instance and calling collectDeviceData.

Swift

let apiClient = BTAPIClient("<TOKENIZATION_KEY_OR_CLIENT_TOKEN>")
let dataCollector = BTDataCollector(apiClient: apiClient)

dataCollector.collectDeviceData { deviceData, error in
    // print("Send this device data to your server: \(deviceData)")
}

Send the device data string to your server along with transaction or verification data (e.g. Transaction.sale calls). Your server will include this device_data parameter when submitting the request to the Braintree gateway.

Note

If you choose to automatically vault a customer's new payment method, verifications for those payment methods will not include device data when they are evaluated by our Premium Fraud Management Tools. Subsequent transactions can still pass device data.

PayPal

If you're accepting PayPal using the Vault flow, collecting device data via BraintreeDataCollector is required.