//stripe/com.stripe.android.model/ConfirmPaymentIntentParams

ConfirmPaymentIntentParams

Model representing parameters for confirming a PaymentIntent.

data class ConfirmPaymentIntentParams : ConfirmStripeIntentParams

Types

Companion

SetupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.Providing this parameter will attach the payment method to the PaymentIntent’s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.When processing card payments, Stripe also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.If setup_future_usage is already set, you may only update the value from OnSession to OffSession.See setup_future_usage.

enum SetupFutureUsage : Enum

Shipping

Shipping information for this PaymentIntent.shipping

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

Functions

component1

operator fun component1(): PaymentMethodCreateParams?

component10

operator fun component10(): PaymentMethodOptionsParams?

component11

operator fun component11(): String?

component12

operator fun component12(): MandateDataParams?

component13

operator fun component13(): ConfirmPaymentIntentParams.SetupFutureUsage?

component14

operator fun component14(): ConfirmPaymentIntentParams.Shipping?

component15

operator fun component15(): String?

component2

operator fun component2(): String?

component3

operator fun component3(): SourceParams?

component4

operator fun component4(): String?

component5

operator fun component5(): Map<String, Any>?

component6

operator fun component6(): String

component7

operator fun component7(): String?

component8

operator fun component8(): Boolean?

copy

fun copy(paymentMethodCreateParams: PaymentMethodCreateParams?, paymentMethodId: String?, sourceParams: SourceParams?, sourceId: String?, extraParams: Map<String, Any>?, clientSecret: String, returnUrl: String?, savePaymentMethod: Boolean?, useStripeSdk: Boolean, paymentMethodOptions: PaymentMethodOptionsParams?, mandateId: String?, mandateData: MandateDataParams?, setupFutureUsage: ConfirmPaymentIntentParams.SetupFutureUsage?, shipping: ConfirmPaymentIntentParams.Shipping?, receiptEmail: String?): ConfirmPaymentIntentParams

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

shouldSavePaymentMethod

fun shouldSavePaymentMethod(): Boolean

shouldUseStripeSdk

open override fun shouldUseStripeSdk(): Boolean

toParamMap

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

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

toString

open override fun toString(): String

withShouldUseStripeSdk

open override fun withShouldUseStripeSdk(shouldUseStripeSdk: Boolean): ConfirmPaymentIntentParams

Properties

clientSecret

The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.The client secret can be used to complete a payment from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.Refer to our docs to accept a payment and learn about how client_secret should be handled.See client_secret.

open override val clientSecret: String

extraParams

val extraParams: Map<String, Any>?

mandateData

This hash contains details about the Mandate to create.See mandate_data.

var mandateData: MandateDataParams?

mandateId

ID of the mandate to be used for this payment.See mandate.

var mandateId: String?

paymentMethodCreateParams

val paymentMethodCreateParams: PaymentMethodCreateParams?

paymentMethodId

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

val paymentMethodId: String?

paymentMethodOptions

Payment-method-specific configuration for this PaymentIntent.See payment_method_options.

var paymentMethodOptions: PaymentMethodOptionsParams?

receiptEmail

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

var receiptEmail: String?

returnUrl

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.See return_url.

var returnUrl: String?

savePaymentMethod

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.If the payment method is already saved to a customer, this does nothing. If this type of payment method cannot be saved to a customer, the request will error.See save_payment_method.

var savePaymentMethod: Boolean?

setupFutureUsage

Indicates that you intend to make future payments with this PaymentIntent’s payment method.See SetupFutureUsage for more information.See setup_future_usage.

var setupFutureUsage: ConfirmPaymentIntentParams.SetupFutureUsage?

shipping

Shipping information for this PaymentIntent.See shipping.

var shipping: ConfirmPaymentIntentParams.Shipping?

sourceId

val sourceId: String?

sourceParams

val sourceParams: SourceParams?