Collect payments while offline

Beta

curl https://api.stripe.com/v1/terminal/configurations \
  -u "
sk_test_4eC39HqLyjWDarjtT1zdp7dc
:" \
  -d "offline[enabled]"=true

import StripeTerminal

class CustomOfflineDelegate: OfflineDelegate {

    func terminal(_ terminal: Terminal, didChangeOfflineStatus offlineStatus: OfflineStatus) {
        // Check the value of `offlineStatus` and update your UI accordingly. For instance,
        // you can check the SDK's network status at `offlineStatus.sdk.networkStatus`.
        //
        // You can also check the SDK's current offline status using
        // `Terminal.shared.offlineStatus.sdk.networkStatus`.
    }

    func terminal(_ terminal: Terminal, didForwardPaymentIntent intent: PaymentIntent, error: Error?) {
        // The PaymentIntent was successfully forwarded, or an error occurred.
        // Reconcile any local state using the backend-generated
        // `PaymentIntent.stripeId` and the locally-generated
        // `PaymentIntent.offlineDetails.stripeId`.
        //
        // Note that the `PaymentIntent.stripeId` may still be nil if creating the
        // PaymentIntent in the backend failed.
    }

    func terminal(_ terminal: Terminal, didReportForwardingError error: Error) {
        // A non-specific error occurred while forwarding a PaymentIntent.
        // Check the error message and your integration implementation to
        // troubleshoot.
    }
}

import UIKit
import StripeTerminal

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
        Terminal.setTokenProvider(APIClient.shared)
        Terminal.shared.offlineDelegate = CustomOfflineDelegate()
        // ...
        return true
    }

    // ...

}

import UIKit
import StripeTerminal

class PaymentViewController: UIViewController {

    // Action for a "Checkout" button
    func checkoutAction() throws {
        // Populate the correct transaction amount from your application.
        let amount = UInt(1000)

        // Build up parameters for creating a `PaymentIntent`
        let params = PaymentIntentParametersBuilder(
            amount: amount,
            currency: "usd"
        )
        .setMetadata(["offlineId": UUID().uuidString])
        .build()

        // Your app might want to prevent offline payments for too large an amount.
        // Here, we block the payment if the amount is over 1000 usd.
        // Otherwise, we allow collecting offline if the network connection is unavailable.
        let offlineBehavior: SCPOfflineBehavior = {
          if amount > UInt(100000) {
            return .requireOnline
          } else {
            return .preferOnline
          }
        }()

        let createConfiguration = try CreateConfigurationBuilder().setOfflineBehavior(offlineBehavior).build()
        Terminal.shared.createPaymentIntent(params, createConfig: createConfiguration) { createResult, createError in
            if let error = createError {
                // Handle offline-specific errors in your application (for example,
                // `offlineBehavior` was set to `.requireOnline` and the SDK is offline).
                print("createPaymentIntent failed: \(error)")
            } else if let paymentIntent = createResult {
                print("createPaymentIntent succeeded")
                // If the `PaymentIntent` was created offline, its `stripeId` field will be nil.
                if let onlineCreatedId = paymentIntent.stripeId {
                    print("created online");
                } else {
                    print("created offline")
                }
            }
        }
    }
}

import UIKit
import StripeTerminal

class PaymentViewController: UIViewController {

    // Action for a "Checkout" button
    func checkoutAction() {
        // SNIP: Create PaymentIntent
        Terminal.shared.collectPaymentMethod(paymentIntent) { collectResult, collectError in
            if let error = collectError {
                // Handle offline-specific errors in your application (for example,
                // unsupported payment method).
                print("collectPaymentMethod failed: \(error)")
            }
            else if let paymentIntent = collectResult {
                print("collectPaymentMethod succeeded")
                // ... Confirm the payment
            }
        }
    }
}

import UIKit
import StripeTerminal

class PaymentViewController: UIViewController {

    // Action for a "Checkout" button
    func checkoutAction() {

        // SNIP: Create PaymentIntent, and collect payment method.
        Terminal.shared.confirmPaymentIntent(paymentIntent) { confirmResult, confirmError in
            if let error = confirmError {
                // Handle offline-specific errors in your application (for example,
                // unsupported payment method).
                print("confirmPaymentIntent failed: \(error)")
            } else if let confirmedPaymentIntent= confirmResult {
                print("confirmPaymentIntent succeeded")
            }
        }
    }
}

// SNIP: Create PaymentIntent, and collect payment method.
Terminal.shared.confirmPaymentIntent(paymentIntent) { confirmResult, confirmError in
    if let error = confirmError {
        // Handle offline-specific errors in your application (for example,
        // unsupported payment method).
        print("confirmPaymentIntent failed: \(error)")
    } else if let confirmedPaymentIntent = confirmResult {
        if intent.status == .requiresCapture {
            if let offlineDetails = confirmedPaymentIntent.offlineDetails(),
               offlineDetails.requiresUpload {
                // Offline payment, wait for `didForwardPaymentIntent` (see snippet below)
            } else {
                // Online payment, can be captured now
            }
        }
        // else, handle other intent.status results here
    }
}

import StripeTerminal

class CustomOfflineDelegate: OfflineDelegate {
    // ...
    func terminal(_ terminal: Terminal, didForwardPaymentIntent intent: PaymentIntent, error: Error?) {
        if let error = error {
            // Handle the error appropriate for your application
            return
        }

        if intent.status == .requiresCapture {
            // The intent is ready to be captured.
        } else {
            // Handle the intent.status as appropriate.
        }
    }
    // ...
}