Feat(): pass return url (new payment methods)

README.md

@@ -90,6 +90,7 @@ Learn at [the official @capacitor-community/stripe documentation](https://stripe
 * [`addListener(PaymentSheetEventsEnum.Canceled, ...)`](#addlistenerpaymentsheeteventsenumcanceled)
 * [`addListener(PaymentSheetEventsEnum.Failed, ...)`](#addlistenerpaymentsheeteventsenumfailed)
 * [`initialize(...)`](#initialize)
+* [`handleURLCallback(...)`](#handleurlcallback)
 * [Interfaces](#interfaces)
 * [Type Aliases](#type-aliases)
 * [Enums](#enums)
@@ -640,6 +641,21 @@ initialize(opts: StripeInitializationOptions) => Promise<void>
 --------------------
 
 
+### handleURLCallback(...)
+
+```typescript
+handleURLCallback(opts: StripeURLHandlingOptions) => Promise<void>
+```
+
+iOS Only
+
+| Param | Type |
+| ---------- | ----------------------------------------------------------------------------- |
+| **`opts`** | <code><a href="#stripeurlhandlingoptions">StripeURLHandlingOptions</a></code> |
+
+--------------------
+
+
 ### Interfaces
 
 
@@ -686,6 +702,7 @@ initialize(opts: StripeInitializationOptions) => Promise<void>
 | **`GooglePayIsTesting`** | <code>boolean</code> | | <code>false,</code> |
 | **`countryCode`** | <code>string</code> | use ApplePay and GooglePay. If set enableApplePay and enableGooglePay false, Plugin ignore here. | <code>"US"</code> |
 | **`merchantDisplayName`** | <code>string</code> | | <code>"App Name"</code> |
+| **`returnURL`** | <code>string</code> | | <code>""</code> |
 | **`style`** | <code>'alwaysLight' \| 'alwaysDark'</code> | iOS Only | <code>undefined</code> |
 | **`withZipCode`** | <code>boolean</code> | Platform: Web only Show ZIP code field. | <code>true</code> |
 
@@ -704,6 +721,7 @@ initialize(opts: StripeInitializationOptions) => Promise<void>
 | **`GooglePayIsTesting`** | <code>boolean</code> | | <code>false,</code> |
 | **`countryCode`** | <code>string</code> | use ApplePay and GooglePay. If set enableApplePay and enableGooglePay false, Plugin ignore here. | <code>"US"</code> |
 | **`merchantDisplayName`** | <code>string</code> | | <code>"App Name"</code> |
+| **`returnURL`** | <code>string</code> | | <code>""</code> |
 | **`style`** | <code>'alwaysLight' \| 'alwaysDark'</code> | iOS Only | <code>undefined</code> |
 | **`withZipCode`** | <code>boolean</code> | Platform: Web only Show ZIP code field. | <code>true</code> |
 
@@ -716,11 +734,19 @@ initialize(opts: StripeInitializationOptions) => Promise<void>
 | **`stripeAccount`** | <code>string</code> | Optional. Making API calls for connected accounts |
 
 
+#### StripeURLHandlingOptions
+
+| Prop | Type |
+| --------- | ------------------- |
+| **`url`** | <code>string</code> |
+
+
 #### StripePlugin
 
-| Method | Signature |
-| -------------- | -------------------------------------------------------------------------------------------------------- |
-| **initialize** | (opts: <a href="#stripeinitializationoptions">StripeInitializationOptions</a>) =&gt; Promise&lt;void&gt; |
+| Method | Signature | Description |
+| --------------------- | -------------------------------------------------------------------------------------------------------- | ----------- |
+| **initialize** | (opts: <a href="#stripeinitializationoptions">StripeInitializationOptions</a>) =&gt; Promise&lt;void&gt; | |
+| **handleURLCallback** | (opts: <a href="#stripeurlhandlingoptions">StripeURLHandlingOptions</a>) =&gt; Promise&lt;void&gt; | iOS Only |
 
 
 #### CapacitorStripeContext

android/build.gradle

@@ -22,10 +22,10 @@ apply plugin: 'kotlin-android'
 apply plugin: 'kotlin-android-extensions'
 
 android {
- compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 30
+ compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 32
  defaultConfig {
  minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 21
- targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 30
+ targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 32
  versionCode 1
  versionName "1.0"
  testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -59,7 +59,7 @@ dependencies {
  testImplementation "junit:junit:$junitVersion"
  androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
  androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
- implementation 'com.stripe:stripe-android:18.2.0'
+ implementation 'com.stripe:stripe-android:20.7.0'
  implementation 'com.google.android.gms:play-services-wallet:19.1.0'
  implementation 'com.google.code.gson:gson:2.8.6'
 

android/src/main/java/com/getcapacitor/community/stripe/StripePlugin.java

@@ -9,9 +9,9 @@
 import com.getcapacitor.community.stripe.helper.MetaData;
 import com.getcapacitor.community.stripe.paymentflow.PaymentFlowExecutor;
 import com.getcapacitor.community.stripe.paymentsheet.PaymentSheetExecutor;
-import com.stripe.android.AppInfo;
 import com.stripe.android.PaymentConfiguration;
 import com.stripe.android.Stripe;
+import com.stripe.android.core.AppInfo;
 import com.stripe.android.googlepaylauncher.GooglePayLauncher;
 import com.stripe.android.paymentsheet.PaymentSheet;
 import org.jetbrains.annotations.NotNull;

ios/Plugin/PaymentFlow/PaymentFlowExecutor.swift

@@ -33,6 +33,11 @@ class PaymentFlowExecutor: NSObject {
  configuration.merchantDisplayName = merchantDisplayName
  }
 
+ let returnURL = call.getString("returnURL") ?? ""
+ if returnURL != "" {
+ configuration.returnURL = returnURL
+ }
+
  if #available(iOS 13.0, *) {
  let style = call.getString("style") ?? ""
  if style == "alwaysLight" {

ios/Plugin/PaymentSheet/PaymentSheetExecutor.swift

@@ -33,6 +33,11 @@ class PaymentSheetExecutor: NSObject {
  configuration.merchantDisplayName = merchantDisplayName
  }
 
+ let returnURL = call.getString("returnURL") ?? ""
+ if returnURL != "" {
+ configuration.returnURL = returnURL
+ }
+
  if #available(iOS 13.0, *) {
  let style = call.getString("style") ?? ""
  if style == "alwaysLight" {

ios/Plugin/StripePlugin.m

@@ -5,6 +5,7 @@
 // each method the plugin supports using the CAP_PLUGIN_METHOD macro.
 CAP_PLUGIN(StripePlugin, "Stripe",
  CAP_PLUGIN_METHOD(initialize, CAPPluginReturnPromise);
+ CAP_PLUGIN_METHOD(handleURLCallback, CAPPluginReturnPromise);
  CAP_PLUGIN_METHOD(createPaymentSheet, CAPPluginReturnPromise);
  CAP_PLUGIN_METHOD(presentPaymentSheet, CAPPluginReturnPromise);
  CAP_PLUGIN_METHOD(createPaymentFlow, CAPPluginReturnPromise);

ios/Plugin/StripePlugin.swift

@@ -34,6 +34,32 @@ public class StripePlugin: CAPPlugin {
  call.resolve()
  }
 
+ @objc func handleURLCallback(_ call: CAPPluginCall) {
+ self.paymentSheetExecutor.plugin = self
+ self.paymentFlowExecutor.plugin = self
+ self.applePayExecutor.plugin = self
+
+ let urlString = call.getString("url") ?? ""
+
+ if urlString == "" {
+ call.reject("you must provide url returned from browser")
+ return
+ }
+
+ let url = URL(string: urlString)!
+ DispatchQueue.main.async {
+ let stripeHandled = StripeAPI.handleURLCallback(with: url)
+ if (stripeHandled) {
+ call.resolve()
+ } else {
+ call.reject("This was not a Stripe url – handle the URL normally as you would")
+ return
+ }
+ }
+
+
+ }
+
  @objc func createPaymentSheet(_ call: CAPPluginCall) {
  self.paymentSheetExecutor.createPaymentSheet(call)
  }

src/definitions.ts

@@ -13,6 +13,11 @@ type StripeDefinitions = PaymentSheetDefinitions & PaymentFlowDefinitions & Appl
 
 export interface StripePlugin extends StripeDefinitions {
  initialize(opts: StripeInitializationOptions): Promise<void>;
+ /**
+ * iOS Only
+ * @url https://stripe.com/docs/payments/3d-secure#return-url
+ */
+ handleURLCallback?(opts: StripeURLHandlingOptions): Promise<void>;
 }
 
 export interface StripeInitializationOptions {
@@ -25,6 +30,10 @@ export interface StripeInitializationOptions {
  stripeAccount?: string;
 }
 
+export interface StripeURLHandlingOptions {
+ url: string;
+}
+
 export interface CapacitorStripeContext {
  stripe: StripePlugin;
  isApplePayAvailable: boolean;

src/shared/index.ts

@@ -81,6 +81,12 @@ export interface BasePaymentOption {
  */
  merchantDisplayName?: string | undefined;
 
+ /**
+ * @url https://stripe.com/docs/payments/accept-a-payment?platform=ios&ui=payment-sheet#ios-set-up-return-url
+ * @default ""
+ */
+ returnURL?: string | undefined;
+
  /**
  * iOS Only
  * @url https://stripe.com/docs/payments/accept-a-payment?platform=ios&ui=payment-sheet#userinterfacestyle