Card issuing Android SDK

Last updated: July 5, 2023

Our CheckoutCardManagement-Android SDK is the mobile gateway to our card issuing solution. The SDK enables your mobile application to:

securely access and display sensitive card details to your cardholders
activate, suspend, or revoke a card
add a card to a Google Pay wallet

Information

You can use the Out-of-Band Authentication Android SDK to authenticate cardholders for digital transactions from within your app.

The SDK supports two environments:

sandbox
production

To use the sandbox and production environments, you must have begun onboarding for card issuing with Checkout.com. During your onboarding you'll receive client credentials, which you'll need to handle on your back end for authentication to access the environments.

When you import the SDK, you can access the environments through the CheckoutCardManager library.

The SDK is distributed as a native Android dependency, which your app can consume through Maven Central.

Use Gradle to import the SDK into your app. In your project-level build.gradle file, add:


1repositories {
2    mavenCentral()
3}

In your app-level build.gradle file, add:


1dependencies {
2    // Required to initialize the CardManagementDesignSystem
3    implementation "androidx.compose.ui:ui:$compose_ui_version"
4    implementation 'com.checkout:checkout-sdk-card-management-android:$checkout_card_management_version'
5}

Information

If you're building a hybrid app, refer to your platform's documentation on how to consume native third-party SDKs.

The CardManagementDesignSystem object defines the look of the UI components displayed to the user. You can set the following properties:

text style, using the properties exposed by the compose.ui.text.TextStyle class
format separator, to set the text separator when formatting the card number


1import androidx.compose.ui.text.TextStyle
2import com.checkout.cardmanagement.CheckoutCardManager
3import com.checkout.cardmanagement.model.Environment
4
5class YourObject {
6
7  // Customizable properties for the secure UI components delivered by the SDK
8  private val cardManagerDesignSystem = CardManagementDesignSystem(
9    textStyle = TextStyle(),
10    panTextSeparator = "-"
11  )
12}

To access the SDK's functionality, instantiate the CheckoutCardManager object within the same object you instantiated CardManagementDesignSystem in:


1import androidx.compose.ui.text.TextStyle
2import com.checkout.cardmanagement.CheckoutCardManager
3import com.checkout.cardmanagement.model.Environment
4
5class YourObject {
6  // Customizable properties for the secure UI components delivered by the SDK
7  private val cardManagerDesignSystem = CardManagementDesignSystem(
8    textStyle = TextStyle(),
9    panTextSeparator = "-"
10  )
11
12  // The main object through which the SDK functionality is accessed
13  private val cardManager = CheckoutCardManager(
14    context = context,
15    designSystem = cardManagerDesignSystem,
16    environment = Environment.SANDBOX
17  )
18}

While Checkout.com handles in-depth compliance, you are required to perform Strong Customer Authentication (SCA) on your users.

You can generate multiple tokens for different systems during a single authentication session. For example, for sign in, to get an SDK session token, or to get an internal authentication token.

However, you can only generate a single SDK session token for each SCA flow requested.

Card issuing Android SDK

Information

SDK environments

Import the SDK

Information

Instantiate the design system

Instantiate the card manager

Authentication requirements

Next steps

Activate, suspend, or revoke a card

Display card details in your app

Add a card to a digital wallet