Token Management Platform SDK

Version 1.3.6

Table of Contents

1. Token Management Platform SDK Overview

   1.1. What is Token Management Platform SDK?

   1.2. How does Token Management Platform SDK work?

   1.3. Versioning and backward compatibility

2. Technical overview

   2.1. Basic information

   2.2. Basic configuration

   2.3. Token Management Platform SDK Setup

   2.4. Error handling

3. Token Management Platform Service

   3.1. getOpaquePaymentCard

   3.2. getTokens (deprecated)

   3.3. activateToken

   3.4. getTokensByActiveWalletId

   3.5. getTokensByReferenceIds

4. Document changelog

   4.1. Version 1.0.0

   4.2. Version 1.0.1

   4.3. Version 1.0.2

   4.4. Version 1.0.3

   4.5. Version 1.0.4

   4.6. Version 1.0.5

   4.7. Version 1.0.6

   4.8. Version 1.0.7

   4.9. Version 1.1.0

   4.10. Version 1.1.1

   4.11. Version 1.1.2

   4.12. Version 1.2.0

   4.13. Version 1.2.1

   4.14. Version 1.2.2

   4.15. Version 1.2.3

   4.16. Version 1.3.0

   4.17. Version 1.3.1

   4.18. Version 1.3.2

   4.19 Version 1.3.3

   4.20 Version 1.3.4

   4.21 Version 1.3.5

   4.22 Version 1.3.6

1. Token Management Platform SDK Overview

1.1 What is Token Management Platform SDK?

Token Management Platform is a solution created in order to allow much easier connection to TSP( MDES, VTS). That can be used for card „pre-digitization” from all Token requestors with minimum development on the issuer side.

1.2 How does Token Management Platform SDK work?

Token Management Platform SDK requires Mobile DC as a dependency. It’s required for the Token Management Platform SDK to work correctly and handles user’s session and data (e.g. cards, addresses). Please read the Mobile DC SDK’s documentation to see more details about the installation and integration process

In order to incorporate this SDK into your app, see Basic configuration

1.3 Versioning and backward compatibility

SDK is based on semantic versioning.
For example: 1.0.0 ( MAJOR.MINOR.PATCH )

• Major version compatibility-breaking changes in SDK public APIs.
  It is mandatory to update application code, to use SDK, when this is incremented.
• Minor version tracks new, not compatibility-breaking changes in public API of SDK.
  It is optional to update application code, when this digit is incremented.
• Patch version tracks internal changes in SDK.
  No updates in application code are necessary to update to version, which has this number incremented.

Changes not breaking compatibility:

• adding new optional interface to SDK setup
• adding new method to any domain
• adding new enum value to input or output
• adding new field in input or output model

2. Technical overview

2.1. Basic information

2.1.1 Facade

Facade is an entry point to communication with Token Management Platform SDK.

2.1.2 Multiple facade types

Token Management Platform SDK provides two public API's with same functionalities, the API's are:

• TokenManagementPlatformCoroutineService for projects which uses Kotlin programming language and Coroutines.
• TokenManagementPlatformStdService for projects which uses Kotlin or Java programming language and standard Callback.

The difference between the API's is a way of providing data to SDK methods and getting the results from them.
Input and output as an data models are the same.
This documentation presents I/O types in a Kotlin way as it's easier to mark nullable fields (as question mark).

2.1.3 Method structure

Every method description has same structure.

Execution type:

• Asynchronous - operation could take more time and method is called on thread different than main. The result of execution is provided in callback (described below).
• Synchronous - result of operation is provided as method return type.

Method type:

• Online - operation requires Internet connection.
• Offline - operation can be called without Internet connection.

Input
Input parameters with name, type and description.

Output
Result delivered by standard Callback with data or result is suspended until the Coroutine completes <Multiple facade types>.

2.2 Basic configuration

2.2.1 Min SDK Version

The minSdkVersion must be at least 23 (Android 6.0).

2.2.2 Artifactory

SDK is available on Verestro maven repository and can be configured in project using Gradle build system.

Username and password are provided by Verestro.

repositories {  
    maven { 
        credentials { 
            username "<enter_username_here>" 
            password "<enter_password_here>" 
        } 
        url "https://artifactory.verestro.com/artifactory/android-release/"
    }
}  

2.2.3 SDKs version

Token Management Platform SDK is available in two versions: debug and release.
The difference between version is debug allows to use application with debugger connected.
Samples below.

For release version, used on production environment in application uploaded to Google Play:

dependencies {  
    implementation 'com.verestro.sdk:tmp:${version}'
    implementation 'pl.upaid.module:mobiledc:{version}'
}  

For debugging purposes:

dependencies {  
    implementation 'com.verestro.sdk:tmp:debug-${version}'
    implementation 'pl.upaid.module:mobiledc:{version}-debug'
}  

2.2.1 Source code obfuscation and optimization

As SDK is written in Kotlin language we recommend to add following code to gradle configuration:

android {  
... 
     kotlinOptions { 
         freeCompilerArgs = [ 
             '-Xno-param-assertions', 
             '-Xno-call-assertions', 
             '-Xno-receiver-assertions' 
        ] 
    }  
    packagingOptions { exclude '/kotlin_metadata/**' } 
...
}  

Then use newest tools for code shrinking, optimization and obfuscation from Google by enabling R8 instead Proguard in gradle.properties file:

android.enableR8=true  

2.3 Token Management Platform SDK Setup

Available configuration methods:

• TokenManagementPlatformCoroutineApi.init(configuration: Configuration)
• TokenManagementPlatformStdApi.init(configuration: Configuration)

2.3.1 Input

Configuration

Configuration

2.3.2 Sample

TokenManagementPlatformCoroutineApi

fun init(configuration: Configuration) {
    TokenManagementPlatformCoroutineApi.init(configuration)
}  

TokenManagementPlatformStdApi

fun init(configuration: Configuration) {
    TokenManagementPlatformStdApi.init(configuration)
}  

2.4 Error handling

SDK returns errors by TmpSdkException, which could be catched by application and shown on UI with detailed message.

Table below describes general exception types.

TmpSdkException

3 Token Management Platform Service

3.1 getOpaquePaymentCard

Asynchronous. Online.  

Provide opaque payment card from backend.

3.1.1 Input

OpaquePaymentCardData

OpaquePaymentCardData

3.1.2 Output

3.1.2.1 Success

Success callback with OpaquePaymentCardResult model.

OpaquePaymentCardResult

OpaquePaymentCardResult

OpaquePaymentCardModel

3.1.2.2 Failure

Failure callback with throwable.

Sample

Standard Callback

fun getOpaquePaymentCard(opaquePaymentCardData: OpaquePaymentCardData) {
    TokenManagementPlatformCoroutineApi
        .tokenManagementPlatformCoroutineService
        .getOpaquePaymentCard(
            opaquePaymentCardData = opaquePaymentCardData,
            callback = object : ApiCallback<OpaquePaymentCardResult> {
                override fun onSuccess(response: OpaquePaymentCardResult) {
                    /*TODO: do something with get opaque payment card */
                }
                override fun onFailure(error: Throwable) {
                    /*TODO: something went wrong*/
                }
            }
        )
}  

Kotlin Coroutines

suspend fun getOpaquePaymentCard(opaquePaymentCardData: OpaquePaymentCardData): OpaquePaymentCardResult =
    TokenManagementPlatformCoroutineApi
        .tokenManagementPlatformCoroutineService
        .getOpaquePaymentCard(opaquePaymentCardData = opaquePaymentCardData) 

3.2 getTokens (deprecated)

Deprecated. Use getTokensByActiveWalletId method instead.

Asynchronous. Online.  

Provide token reference ids from backend.

3.2.1 Input

GetTokensData

GetTokensData

3.2.2 Output

3.2.2.1 Success

Success callback with GetTokensResult model.

GetTokensResult

GetTokensResult

TokenModel

AccountSource

3.2.2.2 Failure

Failure callback with throwable.

3.2.3 Sample

Standard Callback

fun getTokens(getTokensData: GetTokensData) {
    TokenManagementPlatformCoroutineApi
        .tokenManagementPlatformCoroutineService
        .getTokens(
            getTokensData = getTokensData,
            callback = object : ApiCallback<GetTokensResult> {
                override fun onSuccess(response: GetTokensResult) {
                    /*TODO: do something with get opaque payment card */
                }
                override fun onFailure(error: Throwable) {
                    /*TODO: something went wrong*/
                }
            }
        )
}  

Kotlin Coroutines

suspend fun getTokens(getTokensData: GetTokensData): GetTokensResult =
    TokenManagementPlatformCoroutineApi
        .tokenManagementPlatformCoroutineService
        .getTokens(getTokensData = getTokensData) 

3.3 activateToken

Asynchronous. Online.  

Activates token by reference id. Passes verification status in result.

3.3.1 Input

ActivateTokenData

ActivateTokenData

3.3.2 Output

3.3.2.1 Success

Success callback with ActivateTokenResult model.

ActivateTokenResult

ActivateTokenResult

VerificationStatus (deprecated)

VerificationStatusValue

3.3.2.2 Failure

Failure callback with throwable.

3.3.3 Sample

Standard Callback

fun activateToken(activateTokenData: ActivateTokenData) {
    TokenManagementPlatformCoroutineApi
        .tokenManagementPlatformCoroutineService
        .activateToken(
            activateTokenData = activateTokenData,
            callback = object : ApiCallback<ActivateTokenResult> {
                override fun onSuccess(response: ActivateTokenResult) {
                    /*TODO: handle verification status */
                }
                override fun onFailure(error: Throwable) {
                    /*TODO: something went wrong*/
                }
            }
        )
}  

Kotlin Coroutines

suspend fun activateTokenData(activateTokenData: ActivateTokenData): ActivateTokenResult =
    TokenManagementPlatformCoroutineApi
        .tokenManagementPlatformCoroutineService
        .activateToken(activateTokenData = activateTokenData) 

3.4 getTokensByActiveWalletId

Asynchronous. Online.  

Provide tokens from backend.

3.4.1 Input

GetTokensByActiveWalletIdData

GetTokensByActiveWalletIdData

3.4.2 Output

3.4.2.1 Success

Success callback with GetTokensByActiveWalletIdResult model.

GetTokensByActiveWalletIdResult

GetTokensByActiveWalletIdResult

TokenModel

AccountSource

3.4.2.2 Failure

Failure callback with throwable.

3.4.3 Sample

Standard Callback

fun getTokensByActiveWalletId(getTokensByActiveWalletIdData: GetTokensByActiveWalletIdData) {
    TokenManagementPlatformCoroutineApi
        .tokenManagementPlatformCoroutineService
        .getTokensByActiveWalletId(
            getTokensByActiveWalletIdData = getTokensByActiveWalletIdData,
            callback = object : ApiCallback<GetTokensResult> {
                override fun onSuccess(response: GetTokensResult) {
                    /*TODO: do something with get opaque payment card */
                }
                override fun onFailure(error: Throwable) {
                    /*TODO: something went wrong*/
                }
            }
        )
}  

Kotlin Coroutines

suspend fun getTokensByActiveWalletId(getTokensByActiveWalletId: GetTokensByActiveWalletId): GetTokensResult =
    TokenManagementPlatformCoroutineApi
        .tokenManagementPlatformCoroutineService
        .getTokensByActiveWalletId(getTokensByActiveWalletId = getTokensByActiveWalletId) 

3.5 getTokensByReferenceIds

Asynchronous. Online.  

Provide tokens from backend.

3.5.1 Input

GetTokensByReferenceIdsData

GetTokensByReferenceIdsData

3.5.2 Output

3.5.2.1 Success

Success callback with GetTokensByReferenceIdsResult model.

GetTokensByReferenceIdsResult

GetTokensByReferenceIdsResult

TokenModel

AccountSource

3.5.2.2 Failure

Failure callback with throwable.

3.5.3 Sample

Standard Callback

fun getTokensByReferenceIds(getTokensByReferenceIdsData: GetTokensByReferenceIdsData) {
    TokenManagementPlatformCoroutineApi
        .tokenManagementPlatformCoroutineService
        .getTokensByReferenceIds(
            getTokensByReferenceIdsData = getTokensByReferenceIdsData,
            callback = object : ApiCallback<GetTokensResult> {
                override fun onSuccess(response: GetTokensResult) {
                    /*TODO: do something with get opaque payment card */
                }
                override fun onFailure(error: Throwable) {
                    /*TODO: something went wrong*/
                }
            }
        )
}  

Kotlin Coroutines

suspend fun getTokensByReferenceIds(getTokensByReferenceIdsData: GetTokensByReferenceIdsData): GetTokensResult =
    TokenManagementPlatformCoroutineApi
        .tokenManagementPlatformCoroutineService
        .getTokensByReferenceIds(getTokensByReferenceIdsData = getTokensByReferenceIdsData) 

4. Document changelog

4.1. Version 1.0.0

• Created Token Management Platform SDK.

4.2 Version 1.0.1

• Handled validator error exception.

4.3 Version 1.0.2

• Refactored Configuration model.
• Added certificate pinning.

4.4 Version 1.0.3

• Added hostname verification.

4.5 Version 1.0.4

• Refactored getTokenReferenceIds method to getTokens.

4.6 Version 1.0.5

• Updated documentation.

4.7 Version 1.0.6

• Added support for DC access token.

4.8 Version 1.0.7

• Disabled pinning and obfuscation for debug.

4.9 Version 1.1.0

• Removed unnecessary fields from TokenModel.

4.10 Version 1.1.1

• Updated documentation.

4.11 Version 1.1.2

• Updated koin to version 3.5.3.
• Updated java to 17.
• Updated compile and target android version.

4.12 Version 1.2.0

• Added activate token method.

4.13 Version 1.2.1

• Added optional parameter cardsIds to GetTokensData in getTokens method.

4.14 Version 1.2.2

• Marked verificationStatus field in ActivateTokenResult model with @Deprecated.
• Added corresponding value class field verificationStatusValue for deprecated field.

4.15 Version 1.2.3

• Improved SDKs deploying.

4.16 Version 1.3.0

• Marked getTokens method as deprecated
• Added getTokensByActiveWalletId method to get tokens by active wallet id
• Added getTokensByReferenceIds method to get tokens by reference ids

4.17 Version 1.3.1

• Internal changes have been introduced to improve build process.

4.18 Version 1.3.2

• Added lastFourDigits field in ActivateTokenResult model.

4.19 Version 1.3.3

• Update koin to version 4.0.4
• Update java to 21
• Update compile and target android version

4.20 Version 1.3.4

• Internal changes improving SDK delivery process.

4.21 Version 1.3.5

• Remove jcenter repository

4.22 Version 1.3.6

• Added accountSource field in TokenModel model