Skip to content
Create account
 or
Sign in
The Stripe Docs logo
/
Create account
Sign in

Manage payment methods in settings

Use the Payment Method Settings Sheet to let your customers manage their payment methods in your app settings page.

Note

The Payment Method Settings Sheet is intended for use on an app settings page. For checkout and payments, use the In-app Payments, which also has built-in support for saving and displaying payment methods and supports more payment methods than the Payment Method Settings Sheet.

Note

In code, this component is referenced as CustomerSheet for historical reasons. Throughout the documentation, when you see CustomerSheet in code examples, this refers to the Payment Method Settings Sheet.

The Payment Method Settings Sheet is a prebuilt UI component that lets your customers manage their saved payment methods. You can use the Payment Method Settings Sheet UI outside of a checkout flow, and the appearance and styling is customizable to match the appearance and aesthetic of your app. Customers can add and remove payment methods, which get saved to the customer object, and set their default payment method stored locally on the device. Use both the In-app Payments and the Payment Method Settings Sheet to provide customers a consistent end-to-end solution for saved payment methods.

Screenshot of Payment Method Settings Sheet presenting multiple saved payment methods in an iOS app.

CustomerAdapter uses Customer Ephemeral Keys and serves as a bridge to help users of legacy products adopt CustomerSheet more quickly. If you’re starting a new integration, we recommend adopting CustomerSession over Customer Ephemeral Keys.

Set up Stripe

First, you need a Stripe account. Register now.

The Stripe iOS SDK is open source, fully documented, and compatible with apps supporting iOS 13 or above.

To install the SDK, follow these steps:

  1. In Xcode, select File > Add Package Dependencies… and enter https://github.com/stripe/stripe-ios-spm as the repository URL.
  2. Select the latest version number from our releases page.
  3. Add the StripePaymentSheet product to the target of your app.

Note

For details on the latest SDK release and past versions, see the Releases page on GitHub. To receive notifications when a new release is published, watch releases for the repository.

Configure the SDK with your Stripe publishable key on app start. This enables your app to make requests to the Stripe API.

AppDelegate.swift
Swift
No results
import UIKit
import StripePaymentSheet

@main
class AppDelegate: UIResponder, UIApplicationDelegate {

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        StripeAPI.defaultPublishableKey = 
"pk_test_TYooMQauvdEDq54NiTphI7jx"

        // do any other necessary launch configuration
        return true
    }
}

Note

Use your test keys while you test and develop, and your live mode keys when you publish your app.

Enable payment methods

View your payment methods settings and enable the payment methods you want to support. You need at least one payment method enabled to create a SetupIntent.

By default, Stripe enables cards and other prevalent payment methods that can help you reach more customers, but we recommend turning on additional payment methods that are relevant for your business and customers. See Payment method support for product and payment method support, and our pricing page for fees.

Note

CustomerSheet only supports cards, US bank accounts, and SEPA Direct Debit.

Add Customer endpoints
Server-side

Create two endpoints on your server: one for fetching a Customer’s ephemeral key, and one to create a SetupIntent for saving a new payment method to the Customer.

  1. Create an endpoint to return a Customer ID and an associated ephemeral key. You can view the API version used by the SDK here.
Command Line
curl
Ruby
Python
PHP
Node.js
Java
No results
# Create a Customer (skip this and get the existing Customer ID if this is a returning customer)
curl https://api.stripe.com/v1/customers \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -X "POST"

curl https://api.stripe.com/v1/ephemeral_keys \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -X "POST" \
  -d "customer"="{{CUSTOMER_ID}}" \
  1. Create an endpoint to return a SetupIntent configured with the Customer ID.
Command Line
curl
Ruby
Python
PHP
Node.js
Java
No results
# Create a Customer (skip this and get the existing Customer ID if this is a returning customer)
curl https://api.stripe.com/v1/customers \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -X "POST"

curl https://api.stripe.com/v1/setup_intents \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d "customer"="{{CUSTOMER_ID}}" \

If you only plan to use the payment method for future payments when your customer is present during the checkout flow, set the usage parameter to on_session to improve authorization rates.

Create a Customer adapter
Client-side

A StripeCustomerAdapter enables a CustomerSheet to communicate with Stripe. On the client, configure a StripeCustomerAdapter with providers that make requests to these endpoints on your server.

import StripePaymentSheet

let customerAdapter = StripeCustomerAdapter(customerEphemeralKeyProvider: {
    let json = await myBackend.getCustomerEphemeralKey()
    return CustomerEphemeralKey(customerId: json["customerId"]!, ephemeralKeySecret: json["ephemeralKeySecret"]!)
}, setupIntentClientSecretProvider: {
    let json = await myBackend.getSetupIntentForCustomer()
    return json["setupIntentClientSecret"]!
})

Configure the sheet

Next, configure the Payment Method Settings Sheet using the CustomerSheet class with your StripeCustomerAdapter and a CustomerSheet.Configuration.

var configuration = CustomerSheet.Configuration()

// Configure settings for the CustomerSheet here. For example:
configuration.headerTextForSelectionScreen = "Manage your payment method"

let customerSheet = CustomerSheet(configuration: configuration, customer: customerAdapter)

Present the sheet

Present the Payment Method Settings Sheet using CustomerSheet. When the customer dismisses the sheet, the CustomerSheet calls the completion block with a CustomerSheet.SheetResult.

import StripePaymentSheet

customerSheet.present(from: self, completion: { result in
  switch result {
  case .canceled(let paymentOption), .selected(let paymentOption):
    // Configure your UI based on the payment option
    self.paymentLabel.text = paymentOption?.displayData().label ?? "None"

    // Optional: Send the selected payment method ID to your backend for advanced use cases
    // like charging a customer when not present in your app
    if let paymentOption = paymentOption {
      switch paymentOption {
      case .paymentMethod(let paymentMethod, let paymentOptionDisplayData):
        MyBackend.setDefaultPaymentMethod(paymentMethod.stripeId)
      case .applePay(paymentOptionDisplayData: let paymentOptionDisplayData):
        MyBackend.setDefaultPaymentMethodIsApplePay()
      }
    }
  case .error(let error):
    // Show the error in your UI
  }
})
  • If the customer selects a payment method, the result is .selected(PaymentOptionSelection?). The associated value is the selected PaymentOptionSelection, or nil if the user deleted the previously-selected payment method. You can find the full payment method details in the PaymentOptionSelection’s paymentMethod associated value.
  • If the user cancels the sheet, the result is .canceled. The associated value is the original payment method selected prior to opening the customer sheet, as long as that payment method is still available.
  • If an error occurs, the result is .error(Error).

Learn more about how to enable Apple Pay.

OptionalEnable ACH payments

To enable ACH debit payments:

  1. Include StripeFinancialConnections as a dependency for your app.
  2. Enable US Bank Account as a payment method in the settings section of the Dashboard.

OptionalFetch the selected payment method

To fetch the default payment method without presenting the Payment Method Settings Sheet, call retrievePaymentOptionSelection() on the StripeCustomerAdapter.

let paymentMethodOption = try await customerAdapter.retrievePaymentOptionSelection()

// Configure your UI based on the payment option
self.paymentLabel.text = paymentOption?.displayData().label ?? "None"

// Send the selected payment method ID to your backend
switch paymentOption {
case .paymentMethod(paymentMethod: let paymentMethod, paymentOptionDisplayData: let paymentOptionDisplayData):
    try await MyBackend.setDefaultPaymentMethod(paymentMethod.stripeId)
case .applePay(paymentOptionDisplayData: let paymentOptionDisplayData):
    try await MyBackend.setDefaultPaymentMethodIsApplePay()
}

OptionalCustomize the sheet

Appearance

Customize the colors, fonts, and other appearance attributes to match the look and feel of your app by using the appearance API.

Behavior

To add custom behavior for attaching, detaching, and listing saved payment methods, subclass StripeCustomerAdapter or implement your own adapter that conforms to CustomerAdapter.

class MyCustomerAdapter: StripeCustomerAdapter {
    override func fetchPaymentMethods() async throws -> [STPPaymentMethod] {
        let pms = try await super.fetchPaymentMethods()
        // Only return debit cards
        return pms.filter { $0.card?.funding == "debit" }
    }
}

Note

fetchPaymentMethods can filter out saved payment methods from being shown, but won’t impact the type of payment methods that are addable.

Default billing details

To set default values for billing details collected in the payment sheet, configure the defaultBillingDetails property. The CustomerSheet pre-populates its fields with the values that you provide.

var configuration = CustomerSheet.Configuration()
configuration.defaultBillingDetails.address.country = "US"
configuration.defaultBillingDetails.email = "foo@bar.com"

Billing details collection

Use billingDetailsCollectionConfiguration to specify how you want to collect billing details in the payment sheet.

You can collect your customer’s name, email, phone number, and address.

To attach values that aren’t collected by CustomerSheet, add them to the defaultBillingDetails property and set billingDetailsCollectionConfiguration.attachDefaultsToPaymentMethod to true. Make sure that you complete this step if you don’t plan to collect values required by the payment method.

var configuration = CustomerSheet.Configuration()
configuration.defaultBillingDetails.email = "foo@bar.com"
configuration.billingDetailsCollectionConfiguration.name = .always
configuration.billingDetailsCollectionConfiguration.email = .never
configuration.billingDetailsCollectionConfiguration.address = .full
configuration.billingDetailsCollectionConfiguration.attachDefaultsToPaymentMethod = true

Note

Consult with your legal team regarding laws that apply to collecting information. Only collect phone numbers if you need them for the transaction.

Was this page helpful?
YesNo