STPSetupIntentConfirmParams
public class STPSetupIntentConfirmParams : NSObject, NSCopying, STPFormEncodable
An object representing parameters to confirm a SetupIntent object.
For example, you would confirm a SetupIntent when a customer hits the “Save” button on a payment method management view in your app.
If the selected payment method does not require any additional steps from the customer, the SetupIntent’s status will transition to STPSetupIntentStatusSucceeded
. Otherwise, it will transition to STPSetupIntentStatusRequiresAction
, and suggest additional actions via nextAction
.
Instead of passing this to STPAPIClient.confirmSetupIntent(...)
directly, we recommend using STPPaymentHandler
to handle any additional steps for you.
-
Declaration
Swift
@objc public var additionalAPIParameters: [AnyHashable : Any]
-
Initialize this
STPSetupIntentConfirmParams
with aclientSecret
.Declaration
Swift
@objc public init(clientSecret: String)
Parameters
clientSecret
the client secret for this SetupIntent
-
Initialize this
STPSetupIntentConfirmParams
with aclientSecret
andpaymentMethodType
. Use this initializer for SetupIntents that already have a PaymentMethod attached.Declaration
Swift
@objc public init(clientSecret: String, paymentMethodType: STPPaymentMethodType)
Parameters
clientSecret
the client secret for this SetupIntent
paymentMethodType
the known type of the SetupIntent’s attached PaymentMethod
-
The client secret of the SetupIntent. Required.
Declaration
Swift
@objc public var clientSecret: String
-
Provide a supported
STPPaymentMethodParams
object, and Stripe will create a PaymentMethod during PaymentIntent confirmation. @note alternative topaymentMethodId
Declaration
Swift
@objc public var paymentMethodParams: STPPaymentMethodParams?
-
Provide an already created PaymentMethod’s id, and it will be used to confirm the SetupIntent. @note alternative to
paymentMethodParams
Declaration
Swift
@objc public var paymentMethodID: String?
-
The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site. This should probably be a URL that opens your iOS app.
Declaration
Swift
@objc public var returnURL: String?
-
A boolean number to indicate whether you intend to use the Stripe SDK’s functionality to handle any SetupIntent next actions. If set to false, STPSetupIntent.nextAction will only ever contain a redirect url that can be opened in a webview or mobile browser. When set to true, the nextAction may contain information that the Stripe SDK can use to perform native authentication within your app.
Declaration
Swift
@objc public var useStripeSDK: NSNumber?
-
Details about the Mandate to create. @note If this value is null and the
(self.paymentMethod.type == STPPaymentMethodTypeSEPADebit | | self.paymentMethodParams.type == STPPaymentMethodTypeAUBECSDebit || self.paymentMethodParams.type == STPPaymentMethodTypeBacsDebit) && self.mandate == nil
, the SDK will set this to an internal value indicating that the mandate data should be inferred from the current context.Declaration
Swift
@objc public var mandateData: STPMandateDataParams? { get set }
-
Declaration
Swift
public class func rootObjectName() -> String?
-
Declaration
Swift
public class func propertyNamesToFormFieldNamesMapping() -> [String : String]