Venmo Universal Link Return

CHANGELOG.md

@@ -3,7 +3,9 @@
 ## unreleased
 * BraintreePayPal
   * Add `BTPayPalRequest.userPhoneNumber` optional property
-
+* BraintreeVenmo
+  * Add `BTVenmoClient(apiClient:universalLink:)` to use Universal Links when redirecting back from the Venmo flow
+
 ## 6.24.0 (2024-10-15)
 * BraintreePayPal
   * Add `BTPayPalRecurringBillingDetails` and `BTPayPalRecurringBillingPlanType` opt-in request objects. Including these details will provide transparency to users on their billing schedule, dates, and amounts, as well as launch a modernized checkout UI.

Demo/Application/Features/VenmoViewController.swift

@@ -1,11 +1,20 @@
 import UIKit
 import BraintreeVenmo
 
+// swiftlint:disable implicitly_unwrapped_optional
 class VenmoViewController: PaymentButtonBaseViewController {
 
-    // swiftlint:disable:next implicitly_unwrapped_optional
     var venmoClient: BTVenmoClient!
 
+    lazy var universalLinkReturnToggleLabel: UILabel = {
+        let label = UILabel()
+        label.text = "Use Universal Link Return"
+        label.font = .preferredFont(forTextStyle: .footnote)
+        return label
+    }()
+
+    let universalLinkReturnToggle = UISwitch()
+
     override func viewDidLoad() {
         super.viewDidLoad()
         venmoClient = BTVenmoClient(apiClient: apiClient)
@@ -17,7 +26,14 @@ class VenmoViewController: PaymentButtonBaseViewController {
         let venmoECDButton = createButton(title: "Venmo (with ECD options)", action: #selector(tappedVenmoWithECD))
         let venmoUniversalLinkButton = createButton(title: "Venmo Universal Links", action: #selector(tappedVenmoWithUniversalLinks))
 
-        let stackView = UIStackView(arrangedSubviews: [venmoButton, venmoECDButton, venmoUniversalLinkButton])
+        let stackView = UIStackView(
+            arrangedSubviews: [
+                UIStackView(arrangedSubviews: [universalLinkReturnToggleLabel, universalLinkReturnToggle]),
+                venmoButton,
+                venmoECDButton,
+                venmoUniversalLinkButton
+            ]
+        )
         stackView.axis = .vertical
         stackView.spacing = 5
         stackView.alignment = .center
@@ -66,9 +82,17 @@ class VenmoViewController: PaymentButtonBaseViewController {
     }
 
     func checkout(request: BTVenmoRequest) {
+        if universalLinkReturnToggle.isOn {
+            venmoClient = BTVenmoClient(
+                apiClient: apiClient,
+                // swiftlint:disable:next force_unwrapping
+                universalLink: URL(string: "https://mobile-sdk-demo-site-838cead5d3ab.herokuapp.com/braintree-payments")!
+            )
+        }
+
         Task {
             do {
-                let venmoAccount = try await venmoClient.tokenize(request)
+                let venmoAccount = try await (venmoClient).tokenize(request)
                 progressBlock("Got a nonce 💎!")
                 completionBlock(venmoAccount)
             } catch {

Sources/BraintreeVenmo/BTVenmoAppSwitchRedirectURL.swift

@@ -22,9 +22,10 @@ struct BTVenmoAppSwitchRedirectURL {
     // MARK: - Initializer
 
     init(
-        returnURLScheme: String,
         paymentContextID: String,
         metadata: BTClientMetadata,
+        returnURLScheme: String?,
+        universalLink: URL?,
         forMerchantID merchantID: String?,
         accessToken: String?,
         bundleDisplayName: String?,
@@ -46,9 +47,6 @@ struct BTVenmoAppSwitchRedirectURL {
         let base64EncodedBraintreeData = serializedBraintreeData?.base64EncodedString()
 
         queryParameters = [
-            "x-success": constructRedirectURL(with: returnURLScheme, result: "success"),
-            "x-error": constructRedirectURL(with: returnURLScheme, result: "error"),
-            "x-cancel": constructRedirectURL(with: returnURLScheme, result: "cancel"),
             "x-source": bundleDisplayName,
             "braintree_merchant_id": merchantID,
             "braintree_access_token": accessToken,
@@ -57,6 +55,16 @@ struct BTVenmoAppSwitchRedirectURL {
             "braintree_sdk_data": base64EncodedBraintreeData ?? "",
             "customerClient": "MOBILE_APP"
         ]
+
+        if let universalLink {
+            queryParameters["x-success"] = universalLink.absoluteString + "/success"
+            queryParameters["x-error"] = universalLink.absoluteString + "/error"
+            queryParameters["x-cancel"] = universalLink.absoluteString + "/cancel"
+        } else if let returnURLScheme {
+            queryParameters["x-success"] = constructRedirectURL(with: returnURLScheme, result: "success")
+            queryParameters["x-error"] = constructRedirectURL(with: returnURLScheme, result: "error")
+            queryParameters["x-cancel"] = constructRedirectURL(with: returnURLScheme, result: "cancel")
+        }
     }
 
     // MARK: - Internal Methods

Sources/BraintreeVenmo/BTVenmoAppSwitchReturnURL.swift

@@ -41,7 +41,7 @@ struct BTVenmoAppSwitchReturnURL {
     init?(url: URL) {
         let parameters = BTURLUtils.queryParameters(for: url)
 
-        if url.path == "/vzero/auth/venmo/success" {
+        if url.path.contains("success") {
             if let resourceID = parameters["resource_id"] {
                 state = .succeededWithPaymentContext
                 paymentContextID = resourceID
@@ -50,12 +50,12 @@ struct BTVenmoAppSwitchReturnURL {
                 nonce = parameters["paymentMethodNonce"] ?? parameters["payment_method_nonce"]
                 username = parameters["username"]
             }
-        } else if url.path == "/vzero/auth/venmo/error" {
+        } else if url.path.contains("error") {
             state = .failed
             let errorMessage: String? = parameters["errorMessage"] ?? parameters["error_message"]
             let errorCode = Int(parameters["errorCode"] ?? parameters["error_code"] ?? "0")
             error = BTVenmoAppSwitchError.returnURLError(errorCode ?? 0, errorMessage)
-        } else if url.path == "/vzero/auth/venmo/cancel" {
+        } else if url.path.contains("cancel") {
             state = .canceled
         } else {
             state = .unknown
@@ -68,6 +68,7 @@ struct BTVenmoAppSwitchReturnURL {
     /// - Parameter url: an app switch return URL
     /// - Returns: `true` if the url represents a Venmo Touch app switch return
     static func isValid(url: URL) -> Bool {
-        url.host == "x-callback-url" && url.path.hasPrefix("/vzero/auth/venmo/")
+        (url.scheme == "https" && (url.path.contains("cancel") || url.path.contains("success") || url.path.contains("error")))
+        || (url.host == "x-callback-url" && url.path.hasPrefix("/vzero/auth/venmo/"))
     }
 }

Sources/BraintreeVenmo/BTVenmoClient.swift

@@ -46,16 +46,28 @@ import BraintreeCore
     /// Used for sending the type of flow, universal vs deeplink to FPTI
     private var linkType: LinkType?
 
+    private var universalLink: URL?
+
     // MARK: - Initializer
 
-    /// Creates an Apple Pay client
+    /// Creates an Venmo client
     /// - Parameter apiClient: An API client
     @objc(initWithAPIClient:)
     public init(apiClient: BTAPIClient) {
         BTAppContextSwitcher.sharedInstance.register(BTVenmoClient.self)
         self.apiClient = apiClient
     }
 
+    /// Initialize a new Venmo client instance.
+    /// - Parameters:
+    ///   - apiClient: The API Client
+    ///   - universalLink: The URL for the Venmo app to redirect to after user authentication completes. Must be a valid HTTPS URL dedicated to Braintree app switch returns.
+    @objc(initWithAPIClient:universalLink:)
+    public convenience init(apiClient: BTAPIClient, universalLink: URL) {
+        self.init(apiClient: apiClient)
+        self.universalLink = universalLink
+    }
+
     // MARK: - Public Methods
 
     /// Initiates Venmo login via app switch, which returns a BTVenmoAccountNonce when successful.
@@ -151,9 +163,10 @@ import BraintreeCore
 
                 do {
                     let appSwitchURL = try BTVenmoAppSwitchRedirectURL(
-                        returnURLScheme: returnURLScheme,
                         paymentContextID: paymentContextID,
                         metadata: metadata,
+                        returnURLScheme: returnURLScheme,
+                        universalLink: self.universalLink,
                         forMerchantID: merchantProfileID,
                         accessToken: configuration.venmoAccessToken,
                         bundleDisplayName: bundleDisplayName,

UnitTests/BraintreeVenmoTests/BTVenmoAppSwitchRedirectURL_Tests.swift

@@ -7,9 +7,10 @@ class BTVenmoAppSwitchRedirectURL_Tests: XCTestCase {
     func testUrlSchemeURL_whenAllValuesAreInitialized_returnsURLWithPaymentContextID() {
         do {
             let requestURL = try BTVenmoAppSwitchRedirectURL(
-                returnURLScheme: "url-scheme",
                 paymentContextID: "12345",
                 metadata: BTClientMetadata(),
+                returnURLScheme: "url-scheme",
+                universalLink: nil,
                 forMerchantID: "merchant-id",
                 accessToken: "access-token",
                 bundleDisplayName: "display-name",
@@ -29,9 +30,10 @@ class BTVenmoAppSwitchRedirectURL_Tests: XCTestCase {
     func testAppSwitchURL_whenMerchantIDNil_throwsError() {
         do {
             _ = try BTVenmoAppSwitchRedirectURL(
-                returnURLScheme: "url-scheme",
                 paymentContextID: "12345",
                 metadata: BTClientMetadata(),
+                returnURLScheme: "url-scheme",
+                universalLink: nil,
                 forMerchantID: nil,
                 accessToken: "access-token",
                 bundleDisplayName: "display-name",
@@ -47,9 +49,10 @@ class BTVenmoAppSwitchRedirectURL_Tests: XCTestCase {
     func testUniversalLinkURL_whenAllValuesInitialized_returnsURLWithAllValues() {
         do {
             let requestURL = try BTVenmoAppSwitchRedirectURL(
-                returnURLScheme: "url-scheme",
                 paymentContextID: "12345",
                 metadata: BTClientMetadata(),
+                returnURLScheme: nil,
+                universalLink: URL(string: "https://mywebsite.com/braintree-payments"),
                 forMerchantID: "merchant-id",
                 accessToken: "access-token",
                 bundleDisplayName: "display-name",
@@ -60,9 +63,9 @@ class BTVenmoAppSwitchRedirectURL_Tests: XCTestCase {
 
             let components = URLComponents(string: requestURL.universalLinksURL()!.absoluteString)
             guard let queryItems = components?.queryItems else { XCTFail(); return }
-            XCTAssertTrue(queryItems.contains(URLQueryItem(name: "x-success", value: "url-scheme://x-callback-url/vzero/auth/venmo/success")))
-            XCTAssertTrue(queryItems.contains(URLQueryItem(name: "x-error", value: "url-scheme://x-callback-url/vzero/auth/venmo/error")))
-            XCTAssertTrue(queryItems.contains(URLQueryItem(name: "x-cancel", value: "url-scheme://x-callback-url/vzero/auth/venmo/cancel")))
+            XCTAssertTrue(queryItems.contains(URLQueryItem(name: "x-success", value: "https://mywebsite.com/braintree-payments/success")))
+            XCTAssertTrue(queryItems.contains(URLQueryItem(name: "x-error", value: "https://mywebsite.com/braintree-payments/error")))
+            XCTAssertTrue(queryItems.contains(URLQueryItem(name: "x-cancel", value: "https://mywebsite.com/braintree-payments/cancel")))
             XCTAssertTrue(queryItems.contains(URLQueryItem(name: "x-source", value: "display-name")))
             XCTAssertTrue(queryItems.contains(URLQueryItem(name: "braintree_merchant_id", value: "merchant-id")))
             XCTAssertTrue(queryItems.contains(URLQueryItem(name: "braintree_access_token", value: "access-token")))