Getting started with Sources in the iOS SDKDeprecated

Creating a payment using Sources with the iOS SDK is a multi-step process:

1. Create an STPSource object that represents your customer’s payment method.
2. Check if further action is required from your customer.

If no further action is required:

• Confirm the source is ready to use.
• Create a charge request on your backend using the source.

If further action is required:

• Present the user with any information they may need to authorize the charge.
• On your backend, listen to Stripe webhooks to create a charge with the source.
• In your app, display the appropriate confirmation to your customer based on the source’s status.

let cardParams = STPCardParams()
cardParams.name = "Jenny Rosen"
cardParams.number = "4242424242424242"
cardParams.expMonth = 12
cardParams.expYear = 18
cardParams.cvc = "424"

let sourceParams = STPSourceParams.cardParams(withCard: cardParams)
STPAPIClient.shared.createSource(with: sourceParams) { (source, error) in
    if let s = source, s.flow == .none && s.status == .chargeable {
        self.createBackendChargeWithSourceID(s.stripeID)
    }
}

Redirect your customer to authorize a source

For sources that require redirecting your customer to authorize the payment, you need to specify a return URL when you create the source. This allows your customer to be redirected back to your app after they authorize the payment. For this return URL, you can either use a custom URL scheme or a universal link supported by your app. For more information on registering and handling URLs in your app, refer to the Apple documentation:

• Implementing custom URL schemes
• Supporting universal links

To handle redirecting your customer to the URL in the source object’s redirect.url parameter, we recommend using STPRedirectContext, which you can use to open the URL in SFSafariViewController, if available, or mobile Safari otherwise. To use STPRedirectContext, you’ll need to first set up your app delegate to forward URLs to the Stripe SDK.

// This method handles opening native URLs (for example, "your-app://stripe-redirect")
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {
    let stripeHandled = StripeAPI.handleURLCallback(with: url)
    if (stripeHandled) {
        return true
    } else {
        // This was not a stripe url – do whatever url handling your app
        // normally does, if any.
    }
    return false
}

// This method handles opening universal link URLs (for example, "https://example.com/stripe_ios_callback")
func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
    if userActivity.activityType == NSUserActivityTypeBrowsingWeb {
        if let url = userActivity.webpageURL {
            let stripeHandled = StripeAPI.handleURLCallback(with: url)
            if (stripeHandled) {
                return true
            } else {
                // This was not a stripe url – do whatever url handling your app
                // normally does, if any.
            }
        }
    }
    return false
}

STPRedirectContext’s completion block is called after your customer returns to your app. At this point, the user may or may not have completed the authorization process. You can use webhooks on your own server to receive notification of a change in status of the source’s chargeable state. See best practices for more information on how to build a confirmation screen when using sources.

If you’d like more help, check out the example app that demonstrates creating a payment using several different payment methods.