SourceParams

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

Types

Link copied to clipboard
object Companion
Link copied to clipboard
Link copied to clipboard
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

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
fun setApiParameterMap(apiParameterMap: Map<String, Any?>?): SourceParams
Link copied to clipboard
open override fun toParamMap(): Map<String, Any>

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

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

Properties

Link copied to clipboard
var amount: Long? = null

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.

Link copied to clipboard

A Map of the parameters specific to the Source type.

Link copied to clipboard
var 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.

Link copied to clipboard
var flow: SourceParams.Flow? = null

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.

Link copied to clipboard
var metadata: Map<String, String>? = null

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.

Link copied to clipboard

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

Link copied to clipboard
var returnUrl: String? = null

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.

Link copied to clipboard

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

Link copied to clipboard
var token: String? = null

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

Link copied to clipboard

The type of the source to create.

Link copied to clipboard

The type of the source to create.

Link copied to clipboard
var usage: Source.Usage? = null

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.