Package-level declarations

Types

Link copied to clipboard

Implement this callback to interact with an ActionComponent.

Link copied to clipboard
data class ActionComponentData(var paymentData: String? = null, var details: JSONObject? = null) : ModelObject

Class containing the whole request data expected by the /payments/details endpoint. Use ActionComponentData.SERIALIZER to serialize it to a JSONObject.

Link copied to clipboard

Used to configure the method used to handle actions.

Link copied to clipboard
data class Address(var city: String? = null, var country: String? = null, var houseNumberOrName: String? = null, var postalCode: String? = null, var stateOrProvince: String? = null, var street: String? = null) : ModelObject
Link copied to clipboard
data class AddressData(val postalCode: String, val street: String, val stateOrProvince: String, val houseNumberOrName: String, val apartmentSuite: String?, val city: String, val country: String)
Link copied to clipboard

Implement this callback to be able to use Address Lookup functionality.

Link copied to clipboard
sealed class AddressLookupResult

A class that contains the result of address lookup completion call.

Link copied to clipboard
data class Amount(var currency: String? = null, var value: Long = 0) : ModelObject
Link copied to clipboard
data class AnalyticsConfiguration(val level: AnalyticsLevel? = null) : Parcelable

Class that allows configuring internal analytics.

Link copied to clipboard

The different configurable levels of analytics. Learn more about the data we are collecting.

Link copied to clipboard
data class AppData(val id: String? = null, val name: String? = null) : ModelObject
Link copied to clipboard
data class BalanceResult(val balance: Amount?, val transactionLimit: Amount?) : ModelObject
Link copied to clipboard
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:

Link copied to clipboard

Utility class holding currency information.

Link copied to clipboard
Link copied to clipboard

Implement this callback to interact with a PaymentComponent.

Link copied to clipboard
class ComponentError(val exception: CheckoutException)

Data about an error that happened inside a component.

Link copied to clipboard
data class Configuration(var merchantId: String? = null, var gatewayMerchantId: String? = null, var intent: String? = null, var koreanAuthenticationRequired: String? = null, var clientId: String? = null, var scopeId: String? = null) : ModelObject
Link copied to clipboard
data class InputDetail(var items: List<Item>? = null) : ModelObject
Link copied to clipboard
data class Installments(val plan: String?, val value: Int?) : ModelObject
Link copied to clipboard
data class Issuer(var id: String? = null, var name: String? = null, var isDisabled: Boolean = false) : ModelObject
Link copied to clipboard
data class Item(var id: String? = null, var name: String? = null) : ModelObject
Link copied to clipboard
data class LookupAddress(val id: String, val address: AddressData)
Link copied to clipboard
typealias Order = OrderRequest
Link copied to clipboard
data class OrderRequest(val pspReference: String, val orderData: String) : ModelObject
Link copied to clipboard
data class OrderResponse(val pspReference: String, val orderData: String, val amount: Amount?, val remainingAmount: Amount?) : ModelObject
Link copied to clipboard
data class PaymentComponentData<PaymentMethodDetailsT : PaymentMethodDetails>(var paymentMethod: PaymentMethodDetailsT?, var order: OrderRequest?, var amount: Amount?, var storePaymentMethod: Boolean? = null, var shopperReference: String? = null, var billingAddress: Address? = null, var deliveryAddress: Address? = null, var shopperName: ShopperName? = null, var telephoneNumber: String? = null, var shopperEmail: String? = null, var dateOfBirth: String? = null, var socialSecurityNumber: String? = null, var installments: Installments? = null, var supportNativeRedirect: Boolean? = true) : ModelObject

Class containing the parameters that the SDK can infer from a component's configuration and user input, especially the paymentMethod object with the shopper input. Use PaymentComponentData.SERIALIZER to serialize this data to a JSONObject. The rest of the /payments call request data should be filled in, on your server, according to your needs.

Link copied to clipboard

The current state of a PaymentComponent.

Link copied to clipboard
data class PaymentMethod(var type: String? = null, var name: String? = null, var brands: List<String>? = null, var brand: String? = null, var fundingSource: String? = null, var issuers: List<Issuer>? = null, var configuration: Configuration? = null, var details: List<InputDetail>? = null, var apps: List<AppData>? = null) : ModelObject
Link copied to clipboard
data class PaymentMethodsApiResponse(var storedPaymentMethods: List<StoredPaymentMethod>? = null, var paymentMethods: List<PaymentMethod>? = null) : ModelObject

Object that parses and holds the response data from the /paymentMethods endpoint. Use PaymentMethodsApiResponse.SERIALIZER to deserialize this class from your JSON response.

Link copied to clipboard

Helper class with a list of all the currently supported Payment Methods on Components and Drop-In.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class ShopperName(var firstName: String? = null, var infix: String? = null, var lastName: String? = null, var gender: String? = null) : ModelObject
Link copied to clipboard
data class StoredPaymentMethod(var type: String? = null, var name: String? = null, var brand: String? = null, var expiryMonth: String? = null, var expiryYear: String? = null, var holderName: String? = null, var id: String? = null, var lastFour: String? = null, var shopperEmail: String? = null, var supportedShopperInteractions: List<String>? = null, var bankAccountNumber: String? = null, var cashtag: String? = null, var label: String? = null) : ModelObject