payments-core/com.stripe.android.model/Source

Source

data class Source : StripeModel, StripePaymentSource

Model for a Sources API object.

Types

data class CodeVerification : StripeModel

Information related to the code verification flow. Present if the source is authenticated by a verification code (flow is Flow.CodeVerification).

Companion

object Companion

Flow

enum Flow : Enum<Source.Flow>

The authentication flow of the source.

Klarna

data class Klarna(val firstName: String?, val lastName: String?, val purchaseCountry: String?, val clientToken: String?, val payNowAssetUrlsDescriptive: String?, val payNowAssetUrlsStandard: String?, val payNowName: String?, val payNowRedirectUrl: String?, val payLaterAssetUrlsDescriptive: String?, val payLaterAssetUrlsStandard: String?, val payLaterName: String?, val payLaterRedirectUrl: String?, val payOverTimeAssetUrlsDescriptive: String?, val payOverTimeAssetUrlsStandard: String?, val payOverTimeName: String?, val payOverTimeRedirectUrl: String?, val paymentMethodCategories: Set<String>, val customPaymentMethods: Set<String>) : StripeModel

Owner

data class Owner : StripeModel

Information about the owner of the payment instrument that may be used or required by particular source types.

Receiver

data class Receiver : StripeModel

Information related to the receiver flow. Present if flow is Source.Flow.Receiver.

Redirect

data class Redirect(val returnUrl: String?, val status: Source.Redirect.Status?, val url: String?) : StripeModel

Information related to the redirect flow. Present if the source is authenticated by a redirect (flow is Flow.Redirect).

SourceType

annotation class SourceType

Status

enum Status : Enum<Source.Status>

The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.

Usage

enum Usage : Enum<Source.Usage>

Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.

Functions

describeContents

abstract fun describeContents(): Int

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

amount

val amount: Long? = null

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.

clientSecret

val clientSecret: String? = null

The client secret of the source. Used for client-side retrieval using a publishable key.

codeVerification

val codeVerification: Source.CodeVerification? = null

Information related to the code verification flow. Present if the source is authenticated by a verification code (flow is code_verification).

created

val created: Long? = null

Time at which the object was created. Measured in seconds since the Unix epoch.

currency

val currency: String? = null

Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.

flow

val flow: Source.Flow? = null

The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.

open override val id: String?

Unique identifier for the object.

isLiveMode

val isLiveMode: Boolean? = null

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

klarna

val klarna: Source.Klarna

owner

val owner: Source.Owner? = null

Information about the owner of the payment instrument that may be used or required by particular source types.

receiver

val receiver: Source.Receiver? = null

Information related to the receiver flow. Present if the source is a receiver (flow is Flow.Receiver).

redirect

val redirect: Source.Redirect? = null

Information related to the redirect flow. Present if the source is authenticated by a redirect (flow is Flow.REDIRECT).

sourceOrder

val sourceOrder: SourceOrder? = null

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

sourceTypeData

val sourceTypeData: Map<String, Any?>? = null

sourceTypeModel

val sourceTypeModel: SourceTypeModel? = null

statementDescriptor

val statementDescriptor: String? = null

Extra information about a source. This will appear on your customer’s statement every time you charge the source.

status

val status: Source.Status? = null

The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.

type

val type: String

The SourceType of this Source, as one of the enumerated values. If a custom source type has been created, this returns SourceType.UNKNOWN. To get the raw value of an SourceType.UNKNOWN type, use typeRaw.

typeRaw

val typeRaw: String

Gets the type of this source as a String. If it is a known type, this will return a string equal to the SourceType returned from type. This method is not restricted to known types

usage

val usage: Source.Usage? = null

weChat

val weChat: WeChat