Cards SDK for Android¶

The Cards SDK is a solution to ease the integration with the Alviere services.

Features¶

Card Issuance
Digital Wallet
Incentives

Requirements¶

Android Studio Hedgehog or above
Android 6.0 (API level 23) or above
Java 11+

Installation¶

Maven Central¶

1. Add Maven Central to project repositories

repositories {
    // ...
    mavenCentral()
}

2. Add SDK dependency to module's build.gradle file using the latest version.

dependencies {
    // ...
    implementation 'com.alviere.android:cards:X.Y.Z'
}

Manual¶

1. Get the latest version of Cards SDK provided by Alviere and add the files to your .m2 path location. Depending on your operation system, these are the default paths.

Windows: C:\Users\<User_Name>\.m2
Linux: /home/<User_Name>/.m2
Mac: /Users/<user_name>/.m2

2. Add a maven path to include the .m2 path location in project repositories. Add the new path before mavenCentral() to respect fetch order.

repositories {
    // ...
    maven { url "file:/path/to/repo/m2repository/" } // Or use mavenLocal() for default path.
    mavenCentral()
}

3. Add SDK dependency to module's build.gradle file using the version provided by Alviere.

dependencies {
    // ...
    implementation 'com.alviere.android:cards:X.Y.Z'
}

Java Version Support¶

Make sure you have enabled Java 11 language feature support. To do so, guarantee that the following configurations are on the module's build.gradle file.

android {
    // ...
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_11
        targetCompatibility JavaVersion.VERSION_11
    }
    kotlinOptions {
        jvmTarget = JavaVersion.VERSION_11.toString()
    }
}

Usage¶

On your android application class, setup Alviere Initialization.

class AndroidApplication : Application() {

  override fun onCreate() {
    super.onCreate()

    Alviere.init(this)
  }
}

Card Issuance¶

This section describes how to issue and manage cards with the Alviere platform. To start, get the CardsSdk service interface instance or use with Dependency Injection.

private val cardsService = CardsSdk.service

Coroutine Usage¶

Every SDK entry function without UI is a suspend function to run inside a kotlin coroutine. Internal code will run with withContext(Dispatchers.IO) and will return an object of type Response<T>.

val response = cardsService.request(...)
when (response) {
  is Response.Success -> { response.data }
  is Response.Error -> { response.metadata }
}

Callback Usage¶

For every suspend function there is a callback function. UI functions will always work only thru callbacks and callbacks will always run on the main thread. Callbacks Source

Create Card¶

To create a new issued card, use the Cards SDK service method cardsService.createCard. Pass the session_token, the wallet_uuid and the IssueCardRequest model.

val model = IssueCardRequest(...)
cardsService.createCard(
    sessionToken = session_token,
    walletUuid = wallet_uuid,
    data = model,
)

The result of this action will return the newly created IssuedCardDetailsModel on Response.Success and any errors will be returned on Response.Error.

Create Non-Reloadable Prepaid Card¶

To create a new non-reloadable prepaid card, use the Cards SDK service method cardsService.createNonReloadablePrepaidCard. Pass the session_token, the account_uuid, and the NonReloadablePrepaidCardRequest model.

val model = NonReloadablePrepaidCardRequest(...)
cardsService.createCard(
    sessionToken = session_token,
    accountUuid = account_uuid,
    data = model,
)

The result of this action will return the newly created IssuedCardDetailsModel on Response.Success and any errors will be returned on Response.Error.

List Cards¶

To get a list of cards from a wallet, use the Cards SDK service method cardsService.listCards. Pass the session_token, the wallet_uuid and the limit/offset, optionally.

cardsService.listCards(
    sessionToken = session_token,
    walletUuid = wallet_uuid,
)

The result of this action will return the user's wallet cards List<IssuedCardDetailsModel> on Response.Success and any errors will be returned on Response.Error.

Get Card¶

To get a card, use the Cards SDK service method cardsService.getCard. Pass the session_token, the wallet_uuid and the card_uuid.

cardsService.getCard(
    sessionToken = session_token,
    walletUuid = wallet_uuid,
    cardUuid = card_uuid,
)

The result of this action will return the issued card of a wallet IssuedCardDetailsModel on Response.Success and any errors will be returned on Response.Error.

Get Card Image¶

To get a card image, use the Cards SDK service method cardsService.getCardImage. Pass the session_token, the wallet_uuid and the card_uuid.

cardsService.getCardImage(
    sessionToken = session_token,
    walletUuid = wallet_uuid,
    cardUuid = card_uuid,
)

The result of this action will return the issued card image Android Bitmap on Response.Success and any errors will be returned on Response.Error.

Get Card Sensitive Data¶

To get a card sensitive data, use the Cards SDK service method cardsService.getCardSensitiveData. Pass the session_token, the wallet_uuid and the card_uuid.

cardsService.getCardSensitiveData(
    sessionToken = session_token,
    walletUuid = wallet_uuid,
    cardUuid = card_uuid,
)

The result of this action will return the issued card sensitive data IssuedCardSensitiveDataModel on Response.Success and any errors will be returned on Response.Error.

Update Card¶

To update a card, use the Cards SDK service method cardsService.updateCard. Pass the session_token, the wallet_uuid, the card_uuid and the CardUpdateRequest model.

val model = CardUpdateRequest(...)
cardsService.updateCard(
    sessionToken = session_token,
    walletUuid = wallet_uuid,
    cardUuid = card_uuid,
    data = model,
)

The result of this action will return the updated card IssuedCardDetailsModel on Response.Success and any errors will be returned on Response.Error.

Activate Card¶

To activate a card, use the Cards SDK service method cardsService.activateCard. Pass the session_token, the wallet_uuid, the card_uuid and the ActivateCardRequest model.

val model = ActivateCardRequest(...)
cardsService.activateCard(
    sessionToken = session_token,
    walletUuid = wallet_uuid,
    cardUuid = card_uuid,
    data = model,
)