components-core/com.adyen.checkout.components.core/CheckoutConfiguration

CheckoutConfiguration

class CheckoutConfiguration(val environment: Environment, val clientKey: String, val shopperLocale: Locale? = null, val amount: Amount? = null, val analyticsConfiguration: AnalyticsConfiguration? = null, configurationBlock: CheckoutConfiguration.() -> Unit = {}) : Configuration

A generic configuration class that allows customizing the Checkout library. You can use the block parameter to add drop-in or payment method specific configurations. For example:

val checkoutConfiguration = CheckoutConfiguration(
    environment,
    clientKey,
    shopperLocale, // optional
    amount, // not applicable with the Sessions flow
) {
    dropIn {
        setEnableRemovingStoredPaymentMethods(true)
    }
    card {
        setHolderNameRequired(true)
    }
}

Parameters

environment

The Environment to be used for internal network calls from the SDK to Adyen.

clientKey

Your Client Key used for internal network calls from the SDK to Adyen.

shopperLocale

The Locale used to display information to the shopper. By default the shopper locale will match the value passed to the API with the sessions flow, or the primary user locale on the device otherwise. Check out the Sessions API documentation on how to set this value.

amount

The amount of the transaction. Not applicable for the sessions flow. Check out the Sessions API documentation on how to set this value.

analyticsConfiguration

A configuration for the internal analytics of the library.

configurationBlock

A block that allows adding drop-in or payment method specific configurations.

Constructors

CheckoutConfiguration

constructor(environment: Environment, clientKey: String, shopperLocale: Locale? = null, amount: Amount? = null, analyticsConfiguration: AnalyticsConfiguration? = null, configurationBlock: CheckoutConfiguration.() -> Unit = {})