SourceParams

Represents a grouping of parameters needed to create a Source object on the server.
class SourceParams : StripeParamsModel

Types

Companion
Link copied to clipboard
object Companion
OwnerParams
Link copied to clipboard
Information about the owner of the payment instrument that may be used or required by particular source types.See owner.
data class OwnerParams @JvmOverloads() constructor(address: Address?,email: String?,name: String?,phone: String?) : StripeParamsModel, Parcelable

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open override fun hashCode(): Int
setAmount
Link copied to clipboard
fun setAmount(amount: Long?): SourceParams
setApiParameterMap
Link copied to clipboard
fun setApiParameterMap(apiParameterMap: Map<String, Any??>?): SourceParams
setCurrency
Link copied to clipboard
fun setCurrency(currency: String): SourceParams
setExtraParams
Link copied to clipboard
Sets extra params for this source object.
fun setExtraParams(extraParams: Map<String, Any>): SourceParams
setMetaData
Link copied to clipboard
fun setMetaData(metaData: Map<String, String>?): SourceParams
setOwner
Link copied to clipboard
fun setOwner(owner: SourceParams.OwnerParams?): SourceParams
setReturnUrl
Link copied to clipboard
fun setReturnUrl(returnUrl: String): SourceParams
setToken
Link copied to clipboard
fun setToken(token: String): SourceParams
setUsage
Link copied to clipboard
fun setUsage(usage: Source.Usage): SourceParams
toParamMap
Link copied to clipboard
Create a string-keyed map representing this object that is ready to be sent over the network.
open override fun toParamMap(): Map<String, Any>
toString
Link copied to clipboard
open override fun toString(): String

Properties

amount
Link copied to clipboard
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.See amount
var amount: Long?
apiParameterMap
Link copied to clipboard
A Map of the parameters specific to the Source type.
var apiParameterMap: Map<String, Any??>?
currency
Link copied to clipboard
Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready.See currency
var currency: String?
metaData
Link copied to clipboard
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.
var metaData: Map<String, String>?
owner
Link copied to clipboard
Information about the owner of the payment instrument that may be used or required by particular source types.
var owner: SourceParams.OwnerParams?
returnUrl
Link copied to clipboard
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.
var returnUrl: String?
type
Link copied to clipboard
The type of the source to create.
val type: String
typeRaw
Link copied to clipboard
The type of the source to create.
val typeRaw: String
usage
Link copied to clipboard
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.See usage
var usage: Source.Usage?