https://github.com/checkout/checkout-risk-sdk-android
The Risk Android package helps collect device data for merchants with direct integration (standalone) with the package and those using Checkout's Frames Android package.
https://github.com/checkout/checkout-risk-sdk-android
Last synced: about 1 year ago
JSON representation
The Risk Android package helps collect device data for merchants with direct integration (standalone) with the package and those using Checkout's Frames Android package.
- Host: GitHub
- URL: https://github.com/checkout/checkout-risk-sdk-android
- Owner: checkout
- License: mit
- Created: 2023-10-11T12:21:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-23T16:40:43.000Z (about 1 year ago)
- Last Synced: 2025-06-07T02:42:03.096Z (about 1 year ago)
- Language: Kotlin
- Homepage:
- Size: 295 KB
- Stars: 1
- Watchers: 1
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Risk Android package
[](https://jitpack.io/#checkout/checkout-risk-sdk-android)
[](LICENSE)
The package helps collect device data for merchants with direct integration (standalone) with the package and those using [Checkout's Frames Android package](https://github.com/checkout/frames-android).
## Table of contents
- [Risk Android package](#risk-android-package)
- [Table of contents](#table-of-contents)
- [Requirements](#requirements)
- [Documentation](#documentation)
- [Usage guide](#usage-guide)
- [Public API](#public-api)
- [Additional Resources](#additional-resources)
- [Demo projects](#demo-projects)
- [Contributing](#contributing)
- [License](#license)
## Requirements
- Android minimum SDK 21
> Compatibility verified with `targetSdk` versions 21 to 33
## Documentation
### Usage guide
1. Add JitPack repository to the project level build.gradle file:
```
// project gradle file
allprojects {
repositories {
maven { url 'https://jitpack.io' }
maven { url = uri("https://maven.fpregistry.io/releases") }
}
}
```
2. Add Risk SDK dependency to the module gradle file:
```
// module gradle file
dependencies {
implementation 'com.github.checkout:checkout-risk-sdk-android:'
}
```
> You can find more about the installation and available versions on [](https://jitpack.io/#checkout/checkout-risk-sdk-android)
> Please keep in mind that the Jitpack repository should to be added to the project gradle file while the dependency should be added in the module gradle file. (More about build configuration files is available [here](https://developer.android.com/studio/build)).
3. Obtain a public API key from [Checkout Dashboard](https://dashboard.checkout.com/developers/keys).
4. Initialise the package with the `getInstance` method passing in the required configuration (public API key and environment) early-on.
```kotlin
// Example usage of package
val yourConfig = RiskConfig(publicKey = "pk_qa_xxx", environment = RiskEnvironment.QA)
// Initialise the package with the getInstance method early-on
val riskInstance =
Risk.getInstance(
context,
RiskConfig(
BuildConfig.SAMPLE_MERCHANT_PUBLIC_KEY,
RiskEnvironment.QA,
false,
),
).let {
it?.let {
it
} ?: run {
null
}
}
```
5. When the shopper selects Pay, publish the device data with the `publishData` method on the Risk instance and retrieve the `deviceSessionId`.
```kotlin
// Publish the device data with the publishData method
riskInstance?.publishData().let {
if (it is PublishDataResult.Success) {
println("Device session ID: ${it.deviceSessionId}") // dsid_XXXX
}
}
```
### Public API
The package exposes two methods:
1. `getInstance` - This method returns a singleton instance of Risk. When the method is called, preliminary checks are made to Checkout's internal API(s) that retrieve the public keys used to initialise the package for collecting device data. If the checks fail or the merchant is disabled, `null` will be returned, else, if the checks are successful, the `Risk` instance is returned to the consumer of the package which can now be used to publish the data with the `publishData` method.
Arguments
```kotlin
data class RiskConfig(val publicKey: String, val environment: RiskEnvironment, val framesMode: Boolean = false)
// Instance creation of Risk Android package
public class Risk private constructor(...) {
public companion object {
...
public suspend fun getInstance(applicaitonContext: Context, config: RiskConfig): Risk? {
...
}
}
}
enum class RiskEnvironment {
QA,
SANDBOX,
PROD
}
```
Responses
```kotlin
class Risk private constructor(...) {
companion object {
...
suspend fun publishData(...): ... {
...
}
}
}
```
2. `publishData` - This is used to publish and persist the device data.
Arguments
```kotlin
public suspend fun publishData(cardToken: String? = null): PublishDataResult {
...
}
```
Responses
```kotlin
public sealed class PublishDataResult {
public data class Success(val deviceSessionId: String) : PublishDataResult()
public data object PublishFailure : PublishDataResult()
}
```
### Additional Resources
- [Frames Android SDK documentation](https://www.checkout.com/docs/developer-resources/sdks/frames-android-sdk)
## Demo projects
Our sample application showcases our prebuilt UIs and how our SDK works. You can run this locally e.g. with Android Studio after adding your public key as an environment variable. See steps below:
- Add environment variable: For example if your public key is `pk_test_123` you would add the following to your `~/.bash_profile` or `~/.zshrc` file:
`export SAMPLE_MERCHANT_PUBLIC_KEY=pk_test_123`.
- Once you clone the repository, open it in Android Studio and click on the Run button.
## Contributing
Find our guide to start contributing [here](https://github.com/checkout/checkout-risk-sdk-android/blob/main/CONTRIBUTING.md).
## License
Risk Android is released under the MIT license. [See LICENSE](https://github.com/checkout/checkout-risk-sdk-android/blob/main/LICENSE) for details.