Set set_as_default_payment_method field using checkbox value

Stripe/StripeiOSTests/STPPaymentIntentParamsTest.swift

@@ -31,6 +31,7 @@ class STPPaymentIntentParamsTest: XCTestCase {
             XCTAssertNil(params.perform(NSSelectorFromString("saveSourceToCustomer")))
             XCTAssertNil(params.savePaymentMethod)
             XCTAssertNil(params.returnURL)
+            XCTAssertNil(params.setAsDefaultPM)
             XCTAssertNil(params.setupFutureUsage)
             XCTAssertNil(params.useStripeSDK)
             XCTAssertNil(params.mandateData)
@@ -141,6 +142,7 @@ class STPPaymentIntentParamsTest: XCTestCase {
         params.paymentMethodId = "test_payment_method_id"
         params.savePaymentMethod = NSNumber(value: true)
         params.returnURL = "fake://testing_only"
+        params.setAsDefaultPM = NSNumber(value: true)
         params.setupFutureUsage = STPPaymentIntentSetupFutureUsage(
             rawValue: Int(truncating: NSNumber(value: 1))
         )
@@ -172,6 +174,7 @@ class STPPaymentIntentParamsTest: XCTestCase {
         XCTAssertEqual(params.setupFutureUsage, STPPaymentIntentSetupFutureUsage.none)
         XCTAssertEqual(params.savePaymentMethod, paramsCopy.savePaymentMethod)
         XCTAssertEqual(params.returnURL, paramsCopy.returnURL)
+        XCTAssertEqual(params.setAsDefaultPM, paramsCopy.setAsDefaultPM)
         XCTAssertEqual(params.useStripeSDK, paramsCopy.useStripeSDK)
         XCTAssertEqual(params.paymentMethodOptions, paramsCopy.paymentMethodOptions)
         XCTAssertEqual(

Stripe/StripeiOSTests/STPSetupIntentConfirmParamsTest.swift

@@ -24,6 +24,7 @@ class STPSetupIntentConfirmParamsTest: XCTestCase {
             XCTAssertEqual(params.additionalAPIParameters.count, 0)
             XCTAssertNil(params.paymentMethodID)
             XCTAssertNil(params.returnURL)
+            XCTAssertNil(params.setAsDefaultPM)
             XCTAssertNil(params.useStripeSDK)
             XCTAssertNil(params.mandateData)
         }
@@ -94,6 +95,7 @@ class STPSetupIntentConfirmParamsTest: XCTestCase {
         params.paymentMethodParams = STPPaymentMethodParams()
         params.paymentMethodID = "test_payment_method_id"
         params.returnURL = "fake://testing_only"
+        params.setAsDefaultPM = NSNumber(value: true)
         params.useStripeSDK = NSNumber(value: true)
         params.mandateData = STPMandateDataParams(
             customerAcceptance: STPMandateCustomerAcceptanceParams(
@@ -114,6 +116,7 @@ class STPSetupIntentConfirmParamsTest: XCTestCase {
         XCTAssertEqual(params.mandateData, paramsCopy.mandateData)
 
         XCTAssertEqual(params.returnURL, paramsCopy.returnURL)
+        XCTAssertEqual(params.setAsDefaultPM, paramsCopy.setAsDefaultPM)
         XCTAssertEqual(params.useStripeSDK, paramsCopy.useStripeSDK)
         XCTAssertEqual(
             params.additionalAPIParameters as NSDictionary,

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/IntentConfirmParams.swift

@@ -45,6 +45,9 @@ final class IntentConfirmParams {
         }
     }
 
+    /// True if the customer opts to save their payment method as their default payment method.
+    var setAsDefaultPM: Bool?
+
     func makeIcon(updateImageHandler: DownloadManager.UpdateImageHandler?) -> UIImage {
         if let bankName = (financialConnectionsLinkedBank?.bankName ?? instantDebitsLinkedBank?.bankName) {
             return PaymentSheetImageLibrary.bankIcon(for: PaymentSheetImageLibrary.bankIconCode(for: bankName))

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/PaymentSheet+API.swift

@@ -190,7 +190,8 @@ extension PaymentSheet {
                     confirmPaymentMethodType: .new(
                         params: confirmParams.paymentMethodParams,
                         paymentOptions: confirmParams.confirmPaymentMethodOptions,
-                        shouldSave: confirmParams.saveForFutureUseCheckboxState == .selected
+                        shouldSave: confirmParams.saveForFutureUseCheckboxState == .selected,
+                        shouldSetAsDefaultPM: confirmParams.setAsDefaultPM
                     ),
                     paymentIntent: paymentIntent,
                     configuration: configuration
@@ -211,7 +212,8 @@ extension PaymentSheet {
                     confirmPaymentMethodType: .new(
                         params: confirmParams.paymentMethodParams,
                         paymentOptions: confirmParams.confirmPaymentMethodOptions,
-                        shouldSave: false
+                        shouldSave: false,
+                        shouldSetAsDefaultPM: confirmParams.setAsDefaultPM
                     ),
                     setupIntent: setupIntent,
                     configuration: configuration
@@ -232,7 +234,8 @@ extension PaymentSheet {
                     confirmType: .new(
                         params: confirmParams.paymentMethodParams,
                         paymentOptions: confirmParams.confirmPaymentMethodOptions,
-                        shouldSave: confirmParams.saveForFutureUseCheckboxState == .selected
+                        shouldSave: confirmParams.saveForFutureUseCheckboxState == .selected,
+                        shouldSetAsDefaultPM: confirmParams.setAsDefaultPM
                     ),
                     configuration: configuration,
                     intentConfig: intentConfig,
@@ -570,7 +573,9 @@ extension PaymentSheet {
             intent.isSetupFutureUsageSet,
             let paymentMethod = intent.paymentMethod,
             // Can it appear in the list of saved PMs?
-            PaymentSheet.supportedSavedPaymentMethods.contains(paymentMethod.type)
+            PaymentSheet.supportedSavedPaymentMethods.contains(paymentMethod.type),
+            // Should we be writing to local storage?
+            !configuration.allowsSetAsDefaultPM
         else {
             return
         }
@@ -592,12 +597,12 @@ extension PaymentSheet {
     enum ConfirmPaymentMethodType {
         case saved(STPPaymentMethod, paymentOptions: STPConfirmPaymentMethodOptions?)
         /// - paymentMethod: Pass this if you created a PaymentMethod already (e.g. for the deferred flow).
-        case new(params: STPPaymentMethodParams, paymentOptions: STPConfirmPaymentMethodOptions, paymentMethod: STPPaymentMethod? = nil, shouldSave: Bool)
+        case new(params: STPPaymentMethodParams, paymentOptions: STPConfirmPaymentMethodOptions, paymentMethod: STPPaymentMethod? = nil, shouldSave: Bool, shouldSetAsDefaultPM: Bool? = nil)
         var shouldSave: Bool {
             switch self {
             case .saved:
                 return false
-            case .new(_, _, _, let shouldSave):
+            case .new(_, _, _, let shouldSave, _):
                 return shouldSave
             }
         }
@@ -619,7 +624,7 @@ extension PaymentSheet {
             params = STPPaymentIntentParams(clientSecret: paymentIntent.clientSecret, paymentMethodType: paymentMethod.type)
             params.paymentMethodOptions = paymentMethodOptions
             params.paymentMethodId = paymentMethod.stripeId
-        case let .new(paymentMethodParams, paymentMethodoptions, paymentMethod, _shouldSave):
+        case let .new(paymentMethodParams, paymentMethodoptions, paymentMethod, _shouldSave, shouldSetAsDefaultPM):
             shouldSave = _shouldSave
             if let paymentMethod = paymentMethod {
                 paymentMethodType = paymentMethod.type
@@ -632,7 +637,9 @@ extension PaymentSheet {
                 params.paymentMethodOptions = paymentMethodoptions
                 paymentMethodType = paymentMethodParams.type
             }
-
+            if let shouldSetAsDefaultPM {
+                params.setAsDefaultPM = NSNumber(value: shouldSetAsDefaultPM)
+            }
             let requiresMandateData: [STPPaymentMethodType] = [.payPal, .cashApp, .revolutPay, .amazonPay, .klarna]
             if requiresMandateData.contains(paymentMethodType) && paymentIntent.setupFutureUsage == .offSession
             {
@@ -652,7 +659,6 @@ extension PaymentSheet {
         params.paymentMethodOptions = paymentOptions
         params.returnURL = configuration.returnURL
         params.shipping = makeShippingParams(for: paymentIntent, configuration: configuration)
-
         return params
     }
 
@@ -671,7 +677,7 @@ extension PaymentSheet {
             )
             params.paymentMethodID = paymentMethod.stripeId
 
-        case let .new(paymentMethodParams, _, paymentMethod, _):
+        case let .new(paymentMethodParams, _, paymentMethod, _, shouldSetAsDefaultPM):
             if let paymentMethod {
                 params = STPSetupIntentConfirmParams(
                     clientSecret: setupIntent.clientSecret,
@@ -682,6 +688,9 @@ extension PaymentSheet {
                 params = STPSetupIntentConfirmParams(clientSecret: setupIntent.clientSecret)
                 params.paymentMethodParams = paymentMethodParams
             }
+            if let shouldSetAsDefaultPM {
+                params.setAsDefaultPM = NSNumber(value: shouldSetAsDefaultPM)
+            }
             // Paypal & revolut requires mandate_data if setting up
             if params.paymentMethodType == .payPal || params.paymentMethodType == .revolutPay {
                 params.mandateData = .makeWithInferredValues()

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/PaymentSheet+DeferredAPI.swift

@@ -28,7 +28,7 @@ extension PaymentSheet {
                 switch confirmType {
                 case let .saved(savedPaymentMethod, _):
                     paymentMethod = savedPaymentMethod
-                case let .new(params, paymentOptions, newPaymentMethod, shouldSave):
+                case let .new(params, paymentOptions, newPaymentMethod, shouldSave, shouldSetAsDefaultPM):
                     if let newPaymentMethod {
                         let errorAnalytic = ErrorAnalytic(event: .unexpectedPaymentSheetConfirmationError,
                                                           error: PaymentSheetError.unexpectedNewPaymentMethod,
@@ -37,7 +37,7 @@ extension PaymentSheet {
                     }
                     stpAssert(newPaymentMethod == nil)
                     paymentMethod = try await configuration.apiClient.createPaymentMethod(with: params, additionalPaymentUserAgentValues: makeDeferredPaymentUserAgentValue(intentConfiguration: intentConfig))
-                    confirmType = .new(params: params, paymentOptions: paymentOptions, paymentMethod: paymentMethod, shouldSave: shouldSave)
+                    confirmType = .new(params: params, paymentOptions: paymentOptions, paymentMethod: paymentMethod, shouldSave: shouldSave, shouldSetAsDefaultPM: shouldSetAsDefaultPM)
                 }
 
                 // 2. Get Intent client secret from merchant

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/PaymentSheetFormFactory/PaymentSheetFormFactory.swift

@@ -371,7 +371,8 @@ extension PaymentSheetFormFactory {
             isSelectedByDefault: false,
             didToggle: didToggle
         )
-        return PaymentMethodElementWrapper(element) { _, params in
+        return PaymentMethodElementWrapper(element) { defaultCheckbox, params in
+            params.setAsDefaultPM = defaultCheckbox.isSelected
             return params
         }
     }