payments-core/com.stripe.android.model

Package-level declarations

Types

AccountParams

data class AccountParams : TokenParams

Create an account token

AccountRange

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class AccountRange : StripeModel

Address

data class Address @VisibleForTesting constructor(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

data 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

data 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

BankStatuses

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class BankStatuses : StripeModel

BinRange

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class BinRange(val low: String, val high: String) : StripeModel

CardMetadata

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class CardMetadata : StripeModel

CardParams

data class CardParams : TokenParams

Create a card token

ConfirmPaymentIntentParams

data class ConfirmPaymentIntentParams : ConfirmStripeIntentParams

Model representing parameters for confirming a PaymentIntent.

ConfirmSetupIntentParams

data class ConfirmSetupIntentParams : ConfirmStripeIntentParams

Model representing parameters for confirming a SetupIntent.

ConfirmStripeIntentParams

interface ConfirmStripeIntentParams : StripeParamsModel, Parcelable

Interface for params for confirming a PaymentIntent or SetupIntent.

ConsumerPaymentDetails

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class ConsumerPaymentDetails : StripeModel

ConsumerPaymentDetailsCreateParams

sealed class ConsumerPaymentDetailsCreateParams : StripeParamsModel, Parcelable

Model for Link Payment Method creation parameters, used for 'consumers/payment_details' endpoint.

ConsumerSignUpConsentAction

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

enum ConsumerSignUpConsentAction : Enum<ConsumerSignUpConsentAction>

CreateFinancialConnectionsSessionForDeferredPaymentParams

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class CreateFinancialConnectionsSessionForDeferredPaymentParams(val uniqueId: String, val initialInstitution: String? = null, val manualEntryOnly: Boolean? = null, val searchSession: String? = null, val verificationMethod: VerificationMethodParam? = null, val customer: String? = null, val onBehalfOf: String? = null, val amount: Int? = null, val currency: String? = null)

CreateFinancialConnectionsSessionParams

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class CreateFinancialConnectionsSessionParams(val clientSecret: String, val customerName: String, val customerEmailAddress: String?)

Customer

data class Customer : StripeModel

Model for a Stripe Customer object

CustomerBankAccount

data class CustomerBankAccount(val bankAccount: BankAccount) : CustomerPaymentSource

CustomerCard

data class CustomerCard(val card: Card) : CustomerPaymentSource

CustomerPaymentSource

sealed class CustomerPaymentSource : StripeModel

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

CustomerSource

data class CustomerSource(val source: Source) : CustomerPaymentSource

CvcTokenParams

data class CvcTokenParams(cvc: String) : TokenParams

DateOfBirth

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

DeferredIntentParams

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class DeferredIntentParams(val mode: DeferredIntentParams.Mode, val paymentMethodTypes: List<String>, val paymentMethodConfigurationId: String?, val onBehalfOf: String?) : StripeModel

DelicateCardDetailsApi

annotation class DelicateCardDetailsApi

ElementsSession

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class ElementsSession(val linkSettings: ElementsSession.LinkSettings?, val paymentMethodSpecs: String?, val stripeIntent: StripeIntent, val merchantCountry: String?, val isEligibleForCardBrandChoice: Boolean, val isGooglePayEnabled: Boolean, val sessionsError: Throwable? = null) : StripeModel

ElementsSessionParams

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

interface ElementsSessionParams : Parcelable

ExpirationDate

sealed class ExpirationDate

FinancialConnectionsSession

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class FinancialConnectionsSession(val clientSecret: String?, val id: String?) : StripeModel

GooglePayResult

data class GooglePayResult : Parcelable

Result of a successful Google Pay Payment Data Request

IssuingCardPin

data class IssuingCardPin(val pin: String) : StripeModel

KlarnaSourceParams

data class KlarnaSourceParams @JvmOverloads constructor(val purchaseCountry: String, val lineItems: List<KlarnaSourceParams.LineItem>, val customPaymentMethods: Set<KlarnaSourceParams.CustomPaymentMethods> = emptySet(), val billingEmail: String? = null, val billingPhone: String? = null, val billingAddress: Address? = null, val billingFirstName: String? = null, val billingLastName: String? = null, val billingDob: DateOfBirth? = null, val pageOptions: KlarnaSourceParams.PaymentPageOptions? = null) : StripeParamsModel, Parcelable

Model representing parameters for creating a Klarna Source.

ListPaymentMethodsParams

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class ListPaymentMethodsParams(customerId: String, paymentMethodType: PaymentMethod.Type, limit: Int? = null, endingBefore: String? = null, startingAfter: String? = null) : StripeParamsModel, Parcelable

MandateDataParams

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

Mandate Data parameters for confirming a PaymentIntent or confirming a SetupIntent

MicrodepositType

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

enum MicrodepositType : Enum<MicrodepositType>

MobileCardElementConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class MobileCardElementConfig(val cardBrandChoice: MobileCardElementConfig.CardBrandChoice) : StripeModel

PaymentIntent

data class PaymentIntent @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP]) constructor(val id: String?, val paymentMethodTypes: List<String>, val amount: Long?, val canceledAt: Long = 0, val cancellationReason: PaymentIntent.CancellationReason? = null, val captureMethod: PaymentIntent.CaptureMethod = CaptureMethod.Automatic, val clientSecret: String?, val confirmationMethod: PaymentIntent.ConfirmationMethod = ConfirmationMethod.Automatic, val countryCode: String?, val created: Long, val currency: String?, val description: String? = null, val isLiveMode: Boolean, val paymentMethod: PaymentMethod? = null, val paymentMethodId: String? = null, val receiptEmail: String? = null, val status: StripeIntent.Status? = null, val setupFutureUsage: StripeIntent.Usage? = null, val lastPaymentError: PaymentIntent.Error? = null, val shipping: PaymentIntent.Shipping? = null, val unactivatedPaymentMethods: List<String>, val linkFundingSources: List<String> = emptyList(), val nextActionData: StripeIntent.NextActionData? = null, paymentMethodOptionsJsonString: String? = null) : StripeIntent

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

PaymentMethod

data class PaymentMethod @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP]) constructor(val id: String?, val created: Long?, val liveMode: Boolean, code: PaymentMethodCode?, val type: PaymentMethod.Type?, val billingDetails: PaymentMethod.BillingDetails? = null, val customerId: String? = null, val card: PaymentMethod.Card? = null, val cardPresent: PaymentMethod.CardPresent? = null, val fpx: PaymentMethod.Fpx? = null, val ideal: PaymentMethod.Ideal? = null, val sepaDebit: PaymentMethod.SepaDebit? = null, val auBecsDebit: PaymentMethod.AuBecsDebit? = null, val bacsDebit: PaymentMethod.BacsDebit? = null, val sofort: PaymentMethod.Sofort? = null, val upi: PaymentMethod.Upi? = null, val netbanking: PaymentMethod.Netbanking? = null, val usBankAccount: PaymentMethod.USBankAccount? = null) : 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

data class PaymentMethodCreateParams : StripeParamsModel, Parcelable

Model for PaymentMethod creation parameters.

PaymentMethodExtraParams

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

sealed class PaymentMethodExtraParams : StripeParamsModel, Parcelable

PaymentMethodMessage

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class PaymentMethodMessage @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP]) constructor(val displayHtml: String, val learnMoreUrl: String) : StripeModel

PaymentMethodOptionsParams

sealed class PaymentMethodOptionsParams : StripeParamsModel, Parcelable

PaymentMethodPreference

data 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

data 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

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

RadarSession

data class RadarSession(val id: String) : StripeModel

RadarSessionWithHCaptcha

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class RadarSessionWithHCaptcha(val id: String, val passiveCaptchaSiteKey: String?, val passiveCaptchaRqdata: String?) : StripeModel

SetupIntent

data class SetupIntent @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP]) constructor(val id: String?, val cancellationReason: SetupIntent.CancellationReason?, val created: Long, val countryCode: String?, val clientSecret: String?, val description: String?, val isLiveMode: Boolean, val paymentMethod: PaymentMethod? = null, val paymentMethodId: String?, val paymentMethodTypes: List<String>, val status: StripeIntent.Status?, val usage: StripeIntent.Usage?, val lastSetupError: SetupIntent.Error? = null, val unactivatedPaymentMethods: List<String>, val linkFundingSources: List<String>, val nextActionData: StripeIntent.NextActionData?, paymentMethodOptionsJsonString: String? = null) : StripeIntent

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

ShippingInformation

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

Model representing a shipping address object

ShippingMethod

data 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

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

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

SourceParams

data 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

Stripe3ds2AuthParams

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class Stripe3ds2AuthParams(sourceId: String, sdkAppId: String, sdkReferenceNumber: String, sdkTransactionId: String, deviceData: String, sdkEphemeralPublicKey: String, messageVersion: String, maxTimeout: Int, returnUrl: String?) : StripeParamsModel, Parcelable

Stripe3ds2AuthResult

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class Stripe3ds2AuthResult : StripeModel

StripeIntent

interface StripeIntent : StripeModel

An interface for methods available in PaymentIntent and SetupIntent

VerificationMethodParam

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

enum VerificationMethodParam : Enum<VerificationMethodParam>

WeChat

data 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

Functions

getRequestCode

fun StripeIntent.getRequestCode(): Int