payments-core/com.stripe.android.model

Package-level declarations

Types

class Address(val city: String? = null, val country: String? = null, val line1: String? = null, val line2: String? = null, val postalCode: String? = null, val state: String? = null) : StripeModel, StripeParamsModel

Model for an owner address object in the Source api.

AddressJapanParams

class AddressJapanParams(val city: String? = null, val country: String? = null, val line1: String? = null, val line2: String? = null, val postalCode: String? = null, val state: String? = null, val town: String? = null) : StripeParamsModel, Parcelable

BankAccountTokenParams

class BankAccountTokenParams @JvmOverloads constructor(country: String, currency: String, accountNumber: String, accountHolderType: BankAccountTokenParams.Type? = null, accountHolderName: String? = null, routingNumber: String? = null) : TokenParams

Create a bank account token

BankAccountTokenParamsFixtures

object BankAccountTokenParamsFixtures

CardParams

class CardParams : TokenParams

Create a card token

ConfirmationToken

class ConfirmationToken : StripeModel

Confirmation Token objects help transport client-side data collected by Elements to your server for payment confirmation. They capture payment method information, shipping details, and other checkout state from Elements, then pass them to your server where you can use them to confirm a PaymentIntent or SetupIntent.

ConfirmPaymentIntentParams

class ConfirmPaymentIntentParams : ConfirmStripeIntentParams

Model representing parameters for confirming a PaymentIntent.

ConfirmSetupIntentParams

class ConfirmSetupIntentParams : ConfirmStripeIntentParams

Model representing parameters for confirming a SetupIntent.

ConfirmStripeIntentParams

sealed interface ConfirmStripeIntentParams : StripeParamsModel, Parcelable

Interface for params for confirming a PaymentIntent or SetupIntent.

Customer

class Customer : StripeModel

Model for a Stripe Customer object

CustomerBankAccount

class CustomerBankAccount(val bankAccount: BankAccount) : CustomerPaymentSource

CustomerCard

class CustomerCard(val card: Card) : CustomerPaymentSource

CustomerPaymentSource

sealed class CustomerPaymentSource : StripeModel

Model of the "data" object inside a Customer "source" object.

CustomerSource

class CustomerSource(val source: Source) : CustomerPaymentSource

CvcTokenParams

class CvcTokenParams(cvc: String) : TokenParams

DateOfBirth

class DateOfBirth(val day: Int, val month: Int, val year: Int) : StripeParamsModel, Parcelable

DelicateCardDetailsApi

annotation class DelicateCardDetailsApi

ExpirationDate

sealed class ExpirationDate

GooglePayResult

class GooglePayResult : Parcelable

Result of a successful Google Pay Payment Data Request

IssuingCardPin

class IssuingCardPin(val pin: String) : StripeModel

MandateDataParams

class MandateDataParams(type: MandateDataParams.Type) : StripeParamsModel, Parcelable

Mandate Data parameters for confirming a PaymentIntent or confirming a SetupIntent

Networks

class Networks(val preferred: String) : StripeParamsModel, Parcelable

PaymentIntent

class PaymentIntent : StripeIntent

A PaymentIntent tracks the process of collecting a payment from your customer.

PaymentMethod

class PaymentMethod : StripeModel

PaymentMethod objects represent your customer's payment instruments. They can be used with PaymentIntents to collect payments or saved to Customer objects to store instrument details for future payments.

PaymentMethodCode

typealias PaymentMethodCode = String

PaymentMethodCreateParams

class PaymentMethodCreateParams : StripeParamsModel, Parcelable

Model for PaymentMethod creation parameters.

PaymentMethodOptionsParams

sealed class PaymentMethodOptionsParams : StripeParamsModel, Parcelable

PaymentMethodPreference

class PaymentMethodPreference(val intent: StripeIntent, val formUI: String? = null) : StripeModel

This class contains the intent but also some of the settings/configuration/preferences about the behaviors/features of the UI.

PaymentMethodUpdateParams

sealed class PaymentMethodUpdateParams : StripeParamsModel, Parcelable

Model for PaymentMethod update parameters.

PersonTokenParams

class PersonTokenParams(val address: Address? = null, val addressKana: AddressJapanParams? = null, val addressKanji: AddressJapanParams? = null, val dateOfBirth: DateOfBirth? = null, val email: String? = null, val firstName: String? = null, val firstNameKana: String? = null, val firstNameKanji: String? = null, val gender: String? = null, val idNumber: String? = null, val lastName: String? = null, val lastNameKana: String? = null, val lastNameKanji: String? = null, val maidenName: String? = null, val metadata: Map<String, String>? = null, val phone: String? = null, val relationship: PersonTokenParams.Relationship? = null, val ssnLast4: String? = null, val verification: PersonTokenParams.Verification? = null) : TokenParams

Creates a single-use token that represents the details for a person. Use this when creating or updating persons associated with a Connect account. See the documentation to learn more.

PossibleBrands

class PossibleBrands(val brands: List<CardBrand>) : StripeModel

RadarSession

class RadarSession(val id: String) : StripeModel

SetupIntent

class SetupIntent : StripeIntent

A SetupIntent guides you through the process of setting up a customer's payment credentials for future payments.

ShippingInformation

class ShippingInformation(val address: Address? = null, val name: String? = null, val phone: String? = null) : StripeModel, StripeParamsModel

Model representing a shipping address object

ShippingMethod

class ShippingMethod @JvmOverloads constructor(val label: String, val identifier: String, val amount: Long, val currency: Currency, val detail: String? = null) : StripeModel

Model representing a shipping method in the Android SDK.

Source

data class Source : StripeModel, StripePaymentSource

Model for a Sources API object.

SourceOrder

data class SourceOrder : StripeModel

Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.

SourceOrderParams

class SourceOrderParams @JvmOverloads constructor(val items: List<SourceOrderParams.Item>, val shipping: SourceOrderParams.Shipping? = null) : StripeParamsModel, Parcelable

Source order parameters.

SourceParams

class SourceParams : StripeParamsModel, Parcelable

Represents a grouping of parameters needed to create a Source object on the server.

SourceTypeModel

sealed class SourceTypeModel : StripeModel

Models for Source type-specific data

StripeIntent

sealed interface StripeIntent : StripeModel

An interface for methods available in PaymentIntent and SetupIntent

WeChat

class WeChat(val statementDescriptor: String? = null, val appId: String?, val nonce: String?, val packageValue: String?, val partnerId: String?, val prepayId: String?, val sign: String?, val timestamp: String?, val qrCodeUrl: String? = null) : StripeModel

WeChat Pay Payments with Sources

WeChatPayNextAction

data class WeChatPayNextAction : StripeModel

Properties

analyticsValue

val LinkMode.analyticsValue: String

Needed for backwards compatibility, as Elements uses these values for analytics instead of the strings coming from the API.

Functions

getRequestCode

fun StripeIntent.getRequestCode(): Int