Source

data class Source : StripeModel, StripePaymentSource

Model for a Sources API object.

See Sources API Reference.

Types

CodeVerification
Link copied to clipboard
data class CodeVerification : StripeModel
Information related to the code verification flow.
Companion
Link copied to clipboard
object Companion
Flow
Link copied to clipboard
enum Flow : Enum<Source.Flow>
The authentication flow of the source.
Klarna
Link copied to clipboard
data class Klarna(firstName: String?, lastName: String?, purchaseCountry: String?, clientToken: String?, payNowAssetUrlsDescriptive: String?, payNowAssetUrlsStandard: String?, payNowName: String?, payNowRedirectUrl: String?, payLaterAssetUrlsDescriptive: String?, payLaterAssetUrlsStandard: String?, payLaterName: String?, payLaterRedirectUrl: String?, payOverTimeAssetUrlsDescriptive: String?, payOverTimeAssetUrlsStandard: String?, payOverTimeName: String?, payOverTimeRedirectUrl: String?, paymentMethodCategories: Set<String>, customPaymentMethods: Set<String>) : StripeModel
Owner
Link copied to clipboard
data class Owner : StripeModel
Information about the owner of the payment instrument that may be used or required by particular source types.
Receiver
Link copied to clipboard
data class Receiver : StripeModel
Information related to the receiver flow.
Redirect
Link copied to clipboard
data class Redirect(returnUrl: String?, status: Source.Redirect.Status?, url: String?) : StripeModel
Information related to the redirect flow.
SourceType
Link copied to clipboard
annotation class SourceType
Status
Link copied to clipboard
enum Status : Enum<Source.Status>
The status of the source, one of canceled, chargeable, consumed, failed, or pending.
Usage
Link copied to clipboard
enum Usage : Enum<Source.Usage>
Either reusable or single_use.

Functions

describeContents
Link copied to clipboard
abstract fun describeContents(): Int
writeToParcel
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

amount
Link copied to clipboard
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.
clientSecret
Link copied to clipboard
val clientSecret: String? = null
The client secret of the source.
codeVerification
Link copied to clipboard
val codeVerification: Source.CodeVerification? = null
Information related to the code verification flow.
created
Link copied to clipboard
val created: Long? = null
Time at which the object was created.
currency
Link copied to clipboard
val currency: String? = null
Three-letter ISO code for the currency associated with the source.
flow
Link copied to clipboard
val flow: Source.Flow? = null
The authentication flow of the source.
id
Link copied to clipboard
open override val id: String?
Unique identifier for the object.
isLiveMode
Link copied to clipboard
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
Link copied to clipboard
val klarna: Source.Klarna
metaData
Link copied to clipboard
val metaData: Map<String, String>? = null
Set of key-value pairs that you can attach to an object.
owner
Link copied to clipboard
val owner: Source.Owner? = null
Information about the owner of the payment instrument that may be used or required by particular source types.
receiver
Link copied to clipboard
val receiver: Source.Receiver? = null
Information related to the receiver flow.
redirect
Link copied to clipboard
val redirect: Source.Redirect? = null
Information related to the redirect flow.
sourceOrder
Link copied to clipboard
val sourceOrder: SourceOrder? = null
Information about the items and shipping associated with the source.
sourceTypeData
Link copied to clipboard
val sourceTypeData: Map<String, Any?>? = null
sourceTypeModel
Link copied to clipboard
val sourceTypeModel: SourceTypeModel? = null
statementDescriptor
Link copied to clipboard
val statementDescriptor: String? = null
Extra information about a source.
status
Link copied to clipboard
val status: Source.Status? = null
The status of the source, one of canceled, chargeable, consumed, failed, or pending.
type
Link copied to clipboard
val type: String
The SourceType of this Source, as one of the enumerated values.
typeRaw
Link copied to clipboard
val typeRaw: String
Gets the type of this source as a String.
usage
Link copied to clipboard
val usage: Source.Usage? = null
Either reusable or single_use.
weChat
Link copied to clipboard
val weChat: WeChat