Tap to add your card for Payment SheetPrivate preview

To allow customers to tap to add their card in a Payment Sheet, add the following Stripe Terminal dependencies to your project:

dependencies {
  // ...

  // Stripe Terminal SDK
  implementation("com.stripe:stripeterminal-core:5.4.1")
  implementation("com.stripe:stripeterminal-taptopay:5.4.1")
}

The tap to add your card feature uses the Terminal Tap to Pay infrastructure to operate in a dedicated process, making transactions more secure. In this process, we create a second instance of your Application. To avoid unexpected errors from running your code in this process, you can skip initialization in your Application by checking TapToPay.isInTapToPayProcess(). Learn more about the Tap to Pay infrastructure.

// Substitute with your application name, and remember to keep it
// the same as your AndroidManifest.xml
class StripeApplication : Application() {
    override fun onCreate() {
        super.onCreate()

        // Skip initialization if running in the TTPA process.
        if (TapToPay.isInTapToPayProcess()) return

        // For example, this will be skipped.
        TerminalApplicationDelegate.onCreate(this)
    }
}

This integration uses the following Stripe API objects:

• A SetupIntent is an object that represents your intent to set up a customer’s payment method for future payments. The payment methods that customers see during the checkout process are also included on the SetupIntent. You can let Stripe automatically pull payment methods from your Dashboard settings or you can list them manually.
• A Customer is an object that you use to set up future payments by attaching a payment method to it. Create a Customer object when your customer creates an account with your business. If your customer is making a payment as a guest, you can create a Customer object before payment and associate it with your own internal representation of the customer’s account later.

For security reasons, your app can’t create these objects. Instead, add an endpoint on your server that:

• Retrieves the Customer
• Creates a SetupIntent with a card_present payment method type and the Customer ID. If the SetupIntent doesn’t have a payment method type of card_present, the tapped card won’t be saved on the customer’s account.
• Returns the SetupIntent client secret to your app.

// This example sets up an endpoint using the Express framework.
const stripe = require('stripe')('{{SANDBOX-API-KEY}}');

app.post('/create-card-present-setup-intent', async (req, res) => {
  const setupIntent = await stripe.setupIntents.create({
    // Use an existing customer ID
    customer: req.customer.id,
    payment_method_types: ['card_present'],
  });

  res.json({
    setupIntent: setupIntent.client_secret,
  })
});

To allow customers to tap to add their card in a Payment Sheet, you must implement a SetupIntent creation callback for tap to add using createCardPresentSetupIntentCallback.

After your customer taps their card, we attach the payment method to the SetupIntent created from your implementation and save the card for future use.

val paymentSheet = PaymentSheet.Builder { result ->
    // Handle payment sheet result
}
    .createCardPresentSetupIntent {
        val response = server.createCardPresentSetupIntent(customerId)

        return if (response.isSuccess) {
            Result.success(response.body!!.clientSecret)
        } else {
            Result.failure(response.exception)
        }
    }
    .build()

You can test tapping to add your card by using a device supported by the Tap to Pay infrastructure.

• To use the simulated reader, use a sandbox API key and a debuggable build of your application.
• To use the real NFC reader, use a production build of your application with physical test cards to tap on your device.