ConfirmPaymentIntentParams
Model representing parameters for confirming a PaymentIntent.
Types
SetupFutureUsage
Link copied to clipboard
Shipping
Link copied to clipboard
data class Shipping @JvmOverloads() constructor(address: Address,name: String,carrier: String?,phone: String?,trackingNumber: String?) : StripeParamsModel, Parcelable
Content copied to clipboard
Functions
component1
Link copied to clipboard
component10
Link copied to clipboard
component11
Link copied to clipboard
component12
Link copied to clipboard
component13
Link copied to clipboard
component14
Link copied to clipboard
component15
Link copied to clipboard
component2
Link copied to clipboard
component3
Link copied to clipboard
component4
Link copied to clipboard
component5
Link copied to clipboard
component6
Link copied to clipboard
component7
Link copied to clipboard
component8
Link copied to clipboard
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
Content copied to clipboard
equals
Link copied to clipboard
shouldSavePaymentMethod
Link copied to clipboard
shouldUseStripeSdk
Link copied to clipboard
toParamMap
Link copied to clipboard
withShouldUseStripeSdk
Link copied to clipboard
open override fun withShouldUseStripeSdk(shouldUseStripeSdk: Boolean): ConfirmPaymentIntentParams
Content copied to clipboard
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.extraParams
Link copied to clipboard
mandateData
Link copied to clipboard
This hash contains details about the Mandate to create.See mandate_data.
mandateId
Link copied to clipboard
paymentMethodCreateParams
Link copied to clipboard
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.
paymentMethodOptions
Link copied to clipboard
Payment-method-specific configuration for this PaymentIntent.See payment_method_options.
receiptEmail
Link copied to clipboard
Email address that the receipt for the resulting payment will be sent to.See receipt_email.
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.
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.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.
sourceParams
Link copied to clipboard