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

SourceParams

data class SourceParams : StripeParamsModel, Parcelable

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

Types

Companion

object Companion

Flow

enum Flow : Enum<SourceParams.Flow>

OwnerParams

data class OwnerParams @JvmOverloads constructor(address: Address? = null, email: String? = null, name: String? = null, phone: String? = null) : StripeParamsModel, Parcelable

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

Functions

describeContents

abstract fun describeContents(): Int

setApiParameterMap

fun setApiParameterMap(apiParameterMap: Map<String, Any?>?): SourceParams

toParamMap

open override fun toParamMap(): Map<String, Any>

Create a string-keyed map representing this object that is ready to be sent over the network.

writeToParcel

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

Properties

amount

var amount: Long?

Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources. Not supported for receiver type sources, where charge amount may not be specified until funds land.

apiParameterMap

val apiParameterMap: Map<String, Any?>

A Map of the parameters specific to the Source type.

currency

var currency: String?

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

flow

var flow: SourceParams.Flow?

The authentication flow of the source to create. flow is one of redirect, receiver, code_verification, none. It is generally inferred unless a type supports multiple flows.

metadata

var metadata: Map<String, String>?

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

owner

var owner: SourceParams.OwnerParams?

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

returnUrl

var returnUrl: String?

The URL you provide to redirect the customer back to you after they authenticated their payment. It can use your application URI scheme in the context of a mobile application.

sourceOrder

var sourceOrder: SourceOrderParams?

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

token

var token: String?

An optional token used to create the source. When passed, token properties will override source parameters.

type

val type: String

The type of the source to create.

typeRaw

val typeRaw: String

The type of the source to create.

usage

var usage: 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.