ConfirmPaymentIntentParams

Model representing parameters for confirming a PaymentIntent.
data class ConfirmPaymentIntentParams : ConfirmStripeIntentParams

Types

Companion
Link copied to clipboard
object Companion
SetupFutureUsage
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
operator fun component1(): PaymentMethodCreateParams?
component10
Link copied to clipboard
operator fun component10(): PaymentMethodOptionsParams?
component11
Link copied to clipboard
operator fun component11(): String?
component12
Link copied to clipboard
operator fun component12(): MandateDataParams?
component13
Link copied to clipboard
operator fun component13(): ConfirmPaymentIntentParams.SetupFutureUsage?
component14
Link copied to clipboard
operator fun component14(): ConfirmPaymentIntentParams.Shipping?
component15
Link copied to clipboard
operator fun component15(): String?
component2
Link copied to clipboard
operator fun component2(): String?
component3
Link copied to clipboard
operator fun component3(): SourceParams?
component4
Link copied to clipboard
operator fun component4(): String?
component5
Link copied to clipboard
operator fun component5(): Map<String, Any>?
component6
Link copied to clipboard
operator fun component6(): String
component7
Link copied to clipboard
operator fun component7(): String?
component8
Link copied to clipboard
operator fun component8(): Boolean?
copy
Link copied to clipboard
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
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open override fun hashCode(): Int
shouldSavePaymentMethod
Link copied to clipboard
fun shouldSavePaymentMethod(): Boolean
shouldUseStripeSdk
Link copied to clipboard
open override fun shouldUseStripeSdk(): Boolean
toParamMap
Link copied to clipboard
Create a Map representing this object that is prepared for the Stripe API.
open override fun toParamMap(): Map<String, Any>
toString
Link copied to clipboard
open override fun toString(): String
withShouldUseStripeSdk
Link copied to clipboard
open override fun withShouldUseStripeSdk(shouldUseStripeSdk: Boolean): ConfirmPaymentIntentParams

Properties

clientSecret
Link copied to clipboard
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
Link copied to clipboard
val extraParams: Map<String, Any>?
mandateData
Link copied to clipboard
This hash contains details about the Mandate to create.See mandate_data.
var mandateData: MandateDataParams?
mandateId
Link copied to clipboard
ID of the mandate to be used for this payment.See mandate.
var mandateId: String?
paymentMethodCreateParams
Link copied to clipboard
val paymentMethodCreateParams: PaymentMethodCreateParams?
paymentMethodId
Link copied to clipboard
ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.See payment_method.
val paymentMethodId: String?
paymentMethodOptions
Link copied to clipboard
Payment-method-specific configuration for this PaymentIntent.See payment_method_options.
var paymentMethodOptions: PaymentMethodOptionsParams?
receiptEmail
Link copied to clipboard
Email address that the receipt for the resulting payment will be sent to.See receipt_email.
var receiptEmail: String?
returnUrl
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
Indicates that you intend to make future payments with this PaymentIntent’s payment method.See SetupFutureUsage for more information.See setup_future_usage.
shipping
Link copied to clipboard
Shipping information for this PaymentIntent.See shipping.
var shipping: ConfirmPaymentIntentParams.Shipping?
sourceId
Link copied to clipboard
val sourceId: String?
sourceParams
Link copied to clipboard
val sourceParams: SourceParams?