Prerequisites
- Android API level 24+ (minSdk)
- Kotlin 2.0+ with the Compose Compiler Gradle plugin
- Jetpack Compose enabled in your project
- A
clientTokenfrom your server via the Client Session API
Install the SDK
Add the Primer Checkout SDK dependency to your module-levelbuild.gradle.kts:
Payment method dependencies
io.primer:checkout doesn’t include the wrappers for 3DS, Klarna or Stripe ACH. Add one for each of these you enable in the Dashboard. Without the 3DS wrapper, card payments that need 3DS fail, and without the Klarna or Stripe wrapper, that method doesn’t appear in the checkout.
The wrappers ship with the SDK at the same version. With the BOM, leave out the version:
3.0.0-beta.8 for each wrapper. Don’t use the 1.x versions listed on the drop-in and headless pages: those are for SDK 2.x.
Compose Setup
Ensure Jetpack Compose is enabled in your module-levelbuild.gradle.kts. The SDK uses the Kotlin Compose Compiler plugin — add it to your plugins block instead of setting kotlinCompilerExtensionVersion:
The Primer SDK is built against a specific Compose BOM version. We recommend aligning your app’s BOM version with ours to avoid binary incompatibilities. See the Compose BOM to library version mapping for details.
Basic Usage
Add the checkout to your Composable:Verify Installation
Build your project to confirm the SDK is resolved correctly:ProGuard / R8
The SDK includes its own ProGuard rules. No additional configuration is needed for release builds.Next Steps
First Payment
Accept your first payment
Theming
Customize the appearance
Core Concepts
Understand the architecture
Settings
Configure SDK behavior