Mobile SDKs

Securely collect sensitive cardholder data such as the card number and the cvv code in your native iOS or Android app with our new mobile SDKs. Completely outsource your tokenisation processes to our libraries and benefit from a simple, fully PCI DSS compliant integration and features such as:

Smart, secure and state of the art UI components
Card brand identification and input validation
Card scanner
Theme support: Style various items according to your CI
Dark mode support

{% hint style="warning" %} This section covers the credit card number and cvv code tokenizations only.
If you need to process 3D-Secure authentication within your SDKs please refer to our SDK 3D integration. {% endhint %}

1. Distribution & Download

Access the latest version of our SDKs by following the links below and link the latest release to your app projects.

OS	Link	Supported version
	Release notes: Link iOS SDK Reference: Link Integration Link (Github): Link	11 +
	Release notes: Link Android SDK Reference: Link Integration Link (JFrog): Link	5.0 +

Link

Supported version

Release notes: Link
iOS SDK Reference: Link
Integration Link (Github): Link

11 +

Release notes: Link
Android SDK Reference: Link
Integration Link (JFrog): Link

5.0 +

2. Integration

As a next step, continue with the initialization of our iOS or Android SDK.

iOS

For iOS, you can add the SDK to your project by adding a new Swift package dependency in Xcode and pointing to the github repository datatrans.github.io/ios-sdk. By default, enable all packages presented in the package selection. If you are building an App Clip project, you may select only your required packages, which will depend on your payment methods and flows. Please reach out to our support if you are unsure about what packages you required. Besides adding the packages via a Swift package dependency, you can also add the SDK via Cocoapods with pod 'Datatrans'.

Additional requirement for iOS

For the card scanner to work, a usage description for the camera use will be required in your .plist file. If you do not provide a description for the camera use, the app will crash when starting the card scanner.

{% code title=".plist File" %}

Key    :  Privacy - Camera Usage Description   
Value  :  $(PRODUCT_NAME) requires camera access to scan cards.

{% endcode %}

Android

For Android projects, you can link the repo and dependencies as demonstrated here:

{% code title="Android implementation" %}

repositories {
	...
	maven { url 'https://datatrans.jfrog.io/artifactory/mobile-sdk/' }
}

dependencies {
	...
	implementation 'ch.datatrans:android-sdk:2.3.0' // check release notes for latest version
}

{% endcode %}

If you are building an Instant app, you may exclude specific packages that are not required in your project. This will depend on your tokenisation process, however by default you should be able to exclude all components. Please reach out to our support if you are unsure about what packages you can exclude.

{% code title="Excluding Dependencies" %}

dependencies {
	...
	implementation ('ch.datatrans:android-sdk:2.3.1') {  // Check release notes for latest version
		exclude group: 'io.card', module: 'android-sdk'
	}
}

{% endcode %}

The table below lists all the dependencies which can be excluded.

Feature	Group	Module
Credit Card Scanner	`io.card`	`android-sdk`
Google Pay	`com.google.android.gms`	`play-services-wallet`
Samsung Pay	`com.samsung.android.sdk`	`samsungpay`

3. SDK initialisation

Create a tokenization object with your merchantId and paymentMethodTypes to start a tokenisation. Below is an example of the suggested minimum options to start a tokenisation with iOS (Swift) and Android (Kotlin, Java). Please read our detailed classes description for iOS and Android to discover more initialization options.

{% tabs %} {% tab title="Swift" %}

let tokenizationRequest = PCIPTokenization(merchantId: merchantId, paymentMethodTypes: [.Visa, .MasterCard]) 
tokenizationRequest.delegate = self
tokenizationRequest.start(presentingController: navigationController)

{% endtab %}

{% tab title="Kotlin" %}

val tokenizationRequest = PCIPTokenization(merchantId, [VISA, MASTER_CARD])
tokenizationRequest.listener = this
TransactionRegistry.startTokenizationRequest(this, tokenizationRequest)

{% endtab %}

{% tab title="Java" %}

PCIPTokenizationRequest tokenizationRequest = new PCIPTokenization(merchantId, [VISA, MASTER_CARD]);
tokenizationRequest.setListener(this);
TransactionRegistry.INSTANCE.startTokenizationRequest(this, tokenizationRequest);

{% endtab %} {% endtabs %}

After the tokenization has been completed, your PCIPTokenizationDelegate (iOS) or PCIPTokenizationListener (Android) is notified about the success, error or cancel state of the processed tokenization. The tokenizationId as well as additional card meta data are returned in PCIPTokenizationSuccess class.

{% hint style="info" %} It is possible to only collect the CVV code of a card. Please checkinit(merchantId:cvvOnlyCard:) for iOS and PCIPTokenization(merchantId: String, cvvOnlyCard: CvvOnlyCard) for Android in the respective API reference to learn more. {% endhint %}

4. Obtain tokens

To obtain the tokenized values, you first need to submit the tokenizationId returned by the SDK to your server.

Subsequently, call the GET Token API from your server together with the tokenizationId to obtain the tokens for the card number and the CVV code. Additionally, the API returns the expiry dates, the fingerprint of the card number as well as the cardInfo object.

{% swagger baseUrl="https://api.sandbox.datatrans.com" path="/v1/tokenizations/{tokenizationId}" method="post" summary="GET Token" %} {% swagger-description %} The parameters marked with * are mandatory. {% endswagger-description %}

{% swagger-parameter in="path" name="tokenizationId" type="integer" required="true" %} tokenizationId

returned from the library {% endswagger-parameter %}

{% swagger-parameter in="header" name="authorization" type="string" required="true" %} Basic MTEwMDAwNzAwNjpLNnFYMXUkIQ== {% endswagger-parameter %}

{% swagger-response status="200" description="" %}

{
    "alias": "AAABeO_NX9LssdexyrAAAQCsDugEAKc5",
    "fingerprint": "F-dV5V8dE0SZLoTurWbq2HZp",
    "maskedCard": "424242xxxxxx4242",
    "aliasCVV": "MnzXPMHJQYebRpmz-WZycWHG",
    "expiryYear": "21",
    "expiryMonth": "09",
    "cardInfo": {
        "brand": "VISA CREDIT",
        "type": "credit",
        "usage": "consumer",
        "country": "GB",
        "issuer": "DATATRANS"
    }

{% endswagger-response %} {% endswagger %}

Examples

{% tabs %} {% tab title="Request" %}

curl -L -X POST 'https://api.sandbox.datatrans.com/v1/tokenizations/210329160815401747' \
-H 'Authorization: Basic MTEwMDAxNzc4OTpNQUd6UUVEbkVxd001d0Vr' \
-H 'Content-Type: application/json'

{% endtab %}

{% tab title="Response" %}

{
    "paymentMethod": "VIS",
    "alias": "7LHXscqwAAEAAAGCpe2M7PXWj2StAOG6",
    "fingerprint": "F-fgxnFwN-gsIw7y80T-kpBB",
    "maskedCard": "489537xxxxxx6287",
    "aliasCVV": "aYsIbb_KTQSbmWDrqlPp7hXM",
    "expiryYear": "23",
    "expiryMonth": "02",
    "cardInfo": {
        "brand": "VISA",
        "type": "debit",
        "usage": "consumer",
        "country": "US",
        "issuer": "U.S. REGION"
    }
}

{% endtab %} {% endtabs %}

Styling the Theme

You can style various colors in our Mobile SDKs to match your corporate identity. Check the graphic below to see what color properties can be defined.
On iOS, you can define your preferred colors within the class ThemeConfiguration. On Android you can set theming options in your project’s color XML resource file, typically colors.xml. Use the color key names as defined in the table below.

Property	Description	Android	iOS
Background Color¹	Background color of the navigation bars. If this is not specified, the navigation bars will be transparent.	`barBackgroundColor`	`dtpl_bar_background_color`
Bar Link Color²	Color of the buttons in the navigation bars. If this is not specified, the color will be the color set in Link Color.	`barLinkColor`	`dtpl_bar_link_color`
Bar Title Color³	Color of the title within the navigation bars. If this is not specified, the color will be the text color. The text color is either white or black and cannot be customized.	`barTitleColor`	`dtpl_bar_title_color`
Button Color⁴	Background color of large buttons, such as the Pay button. If this is not specified, the color will be the color set in Link Color.	`buttonColor`	`dtpl_button_color`
Button Text Color⁵	Text color of large buttons, such as the Pay button. If this is not specified, the color will be set to white.	`buttonTextColor`	`dtpl_button_text_color`
Link Color⁶	Color of text-only buttons or links and the text cursor. If this is not specified, the link color will be in a blue tone.	`linkColor`	`dtpl_link_color`

Language Support

Our iOS and Android Mobile SDK integrations are currently translated and supported in the following languages:

English en
German de
French fr
Italian it

Please get in touch should you need an additional language to be added for your checkout or if you find a translation error.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mobile SDKs

1. Distribution & Download

2. Integration

iOS

Additional requirement for iOS

Android

3. SDK initialisation

4. Obtain tokens

Examples

Styling the Theme

Language Support

FilesExpand file tree

mobile-sdks.md

Latest commit

History

mobile-sdks.md

File metadata and controls

Mobile SDKs

1. Distribution & Download

2. Integration

iOS

Additional requirement for iOS

Android

3. SDK initialisation

4. Obtain tokens

Examples

Styling the Theme

Language Support