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

ConfirmPaymentIntentParams

data class ConfirmPaymentIntentParams : ConfirmStripeIntentParams

Model representing parameters for confirming a PaymentIntent.

Types

object Companion

SetupFutureUsage

enum SetupFutureUsage : Enum<ConfirmPaymentIntentParams.SetupFutureUsage>

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

data class Shipping @JvmOverloads constructor(address: Address, name: String, carrier: String? = null, phone: String? = null, trackingNumber: String? = null) : StripeParamsModel, Parcelable

Shipping information for this PaymentIntent.

Properties

open override val clientSecret: String

The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.

var mandateData: MandateDataParams?

This hash contains details about the Mandate to create.

var mandateId: String?

ID of the mandate to be used for this payment.

paymentMethodCreateParams

val paymentMethodCreateParams: PaymentMethodCreateParams? = null

paymentMethodId

val paymentMethodId: String? = null

ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.

paymentMethodOptions

var paymentMethodOptions: PaymentMethodOptionsParams?

Payment-method-specific configuration for this PaymentIntent.

var receiptEmail: String?

Email address that the receipt for the resulting payment will be sent to.

open override var returnUrl: String?

The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site. If you’d prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods.

savePaymentMethod

var savePaymentMethod: Boolean?

If the PaymentIntent has a payment_method and a customer or if you’re attaching a payment method to the PaymentIntent in this request, you can pass save_payment_method=true to save the payment method to the customer. Defaults to false.

setupFutureUsage

var setupFutureUsage: ConfirmPaymentIntentParams.SetupFutureUsage?

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

var shipping: ConfirmPaymentIntentParams.Shipping?

Shipping information for this PaymentIntent.

val sourceId: String? = null

val sourceParams: SourceParams? = null

Functions

describeContents

abstract fun describeContents(): Int

shouldSavePaymentMethod

fun shouldSavePaymentMethod(): Boolean

shouldUseStripeSdk

open override fun shouldUseStripeSdk(): Boolean

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

Create a Map representing this object that is prepared for the Stripe API.

withShouldUseStripeSdk

open override fun withShouldUseStripeSdk(shouldUseStripeSdk: Boolean): ConfirmPaymentIntentParams

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