Add PaymentSheet FlowController didCancel presentation APIs to React Native SDK (#2079)

* added didCancel support in React Native

* update ios version

* revert podfile lock

* revert script changes

* remove console log

* applied suggestion

* default nil

* cleaner?

* lint

* changelog

Author: joyceqin-stripe

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## X.XX.X - XXXX-XX-XX
+**Features**
+- [#2079](https://github.com/stripe/stripe-react-native/pull/2079) Added support to differentiate between a user closing FlowController and selecting a payment option
+
 ## 0.51.0 - 2025-08-20
 
 **Features**

android/src/main/java/com/reactnativestripesdk/PaymentSheetFragment.kt

@@ -132,7 +132,8 @@ class PaymentSheetFragment :
             val option: WritableMap = WritableNativeMap()
             option.putString("label", it.label)
             option.putString("image", imageString)
-            createResult("paymentOption", option)
+            val additionalFields: Map<String, Any> = mapOf("didCancel" to paymentOptionResult.didCancel)
+            createResult("paymentOption", option, additionalFields)
           }
             ?: run {
               if (paymentSheetTimedOut) {

android/src/main/java/com/reactnativestripesdk/utils/Mappers.kt

@@ -33,9 +33,11 @@ import com.stripe.android.paymentsheet.PaymentSheet
 internal fun createResult(
   key: String,
   value: WritableMap,
+  additionalFields: Map<String, Any>? = null,
 ): WritableMap {
   val map = WritableNativeMap()
   map.putMap(key, value)
+  additionalFields?.let { map.merge(it.toReadableMap()) }
   return map
 }
 

ios/Mappers.swift

@@ -2,8 +2,11 @@ import Stripe
 import StripePaymentSheet
 
 class Mappers {
-    class func createResult(_ key: String, _ value: NSDictionary?) -> NSDictionary {
-        return [key: value ?? NSNull()]
+    class func createResult(_ key: String, _ value: NSDictionary?, additionalFields: [String: Any]? = nil) -> NSDictionary {
+        let result = NSMutableDictionary()
+        result[key] = value ?? NSNull()
+        additionalFields?.forEach { (a, b) in result[a] = b }
+        return result
     }
 
     class func mapToPKContactField(field: String) -> PKContactField {

ios/StripeSdkImpl.swift

@@ -211,14 +211,14 @@ public class StripeSdkImpl: NSObject, UIAdaptivePresentationControllerDelegate {
             paymentSheetViewController = UIApplication.shared.delegate?.window??.rootViewController ?? UIViewController()
             if let paymentSheetFlowController = self.paymentSheetFlowController {
                 paymentSheetFlowController.presentPaymentOptions(from: findViewControllerPresenter(from: paymentSheetViewController!)
-                ) {
+                ) { didCancel in
                     paymentSheetViewController = nil
                     if let paymentOption = self.paymentSheetFlowController?.paymentOption {
                         let option: NSDictionary = [
                             "label": paymentOption.label,
                             "image": paymentOption.image.pngData()?.base64EncodedString() ?? ""
                         ]
-                        resolve(Mappers.createResult("paymentOption", option))
+                        resolve(Mappers.createResult("paymentOption", option, additionalFields: ["didCancel": didCancel]))
                     } else {
                         resolve(Errors.createError(ErrorType.Canceled, "The payment option selection flow has been canceled"))
                     }

src/functions.ts

@@ -435,7 +435,7 @@ export const presentPaymentSheet = async (
   options: PaymentSheet.PresentOptions = {}
 ): Promise<PresentPaymentSheetResult> => {
   try {
-    const { paymentOption, error } =
+    const { paymentOption, didCancel, error } =
       await NativeStripeSdk.presentPaymentSheet(options);
     if (error) {
       return {
@@ -444,6 +444,7 @@ export const presentPaymentSheet = async (
     }
     return {
       paymentOption: paymentOption!,
+      didCancel: didCancel,
     };
   } catch (error: any) {
     return {

src/types/index.ts

@@ -154,6 +154,7 @@ export type InitPaymentSheetResult =
 
 export type PresentPaymentSheetResult = {
   paymentOption?: PaymentSheet.PaymentOption | undefined;
+  didCancel?: boolean;
   error?: StripeError<PaymentSheetError> | undefined;
 };