# Collect card payments while offline Collect card payments when you have internet connectivity issues. # Android The Terminal SDK allows your application to continue collecting payments using a smart reader without an Internet connection. If you’re using a separate POS device with a Stripe smart reader, you still need a functioning local network to allow your POS device to communicate with the smart reader. Operating offline with smart readers is for scenarios where your POS and reader can’t communicate with Stripe, such as during an ISP outage. If you need to operate offline without a local network, consider Stripe Terminal’s [mobile readers](https://docs.stripe.com/terminal/mobile-readers.md). You can also operate offline with an Apps on Devices integration. Since your POS application runs directly on the smart reader, you don’t need a local network to collect payments. However, you still need to be on a local network when your reader first boots up, even if the network doesn’t have access to the Internet. > When operating offline, payment information is collected at the time of sale, and authorization is only attempted after connectivity is restored and the payment is forwarded. When operating offline with a smart reader, the reader stores collected payment information. You, as the user, assume all decline and tamper-related risks associated with an offline transaction. If your tampered reader can’t forward payments to Stripe, or the issuer declines the transaction, there’s no way to recover the funds, and you might not receive payment from the customer for goods or services already provided. > > To reduce the chances of an issuer decline, you’re encouraged to: > > - Reestablish internet connectivity as soon as possible to record the payments to Stripe. - Restrict transactions if they exceed a certain amount. - [Fail all offline payments](https://docs.stripe.com/terminal/features/operate-offline/collect-card-payments.md#managing-risk) if the SDK has stored a set of transactions whose sum exceeds a certain amount. ## Collect payments while offline Offline payments follow the same steps as online payments: create, collect, process, and capture the payment. Your device can transition from online to offline at any step in the process. 1. [Enable offline mode](https://docs.stripe.com/terminal/features/operate-offline/collect-card-payments.md#enable-offline-mode) 2. [Connect to a reader while offline](https://docs.stripe.com/terminal/features/operate-offline/collect-card-payments.md#connect-while-offline) 3. [Handle offline events](https://docs.stripe.com/terminal/features/operate-offline/collect-card-payments.md#handle-offline-events) 4. [Create a PaymentIntent while offline](https://docs.stripe.com/terminal/features/operate-offline/collect-card-payments.md#create-payment-intent) 5. [Collect a payment method](https://docs.stripe.com/terminal/features/operate-offline/collect-card-payments.md#collect-payment-method) 6. [Confirm the payment](https://docs.stripe.com/terminal/features/operate-offline/collect-card-payments.md#confirm-payment) 7. [Wait for payments to forward](https://docs.stripe.com/terminal/features/operate-offline/collect-card-payments.md#wait-for-forward) 8. (Optional) [Capture the payment](https://docs.stripe.com/terminal/features/operate-offline/collect-card-payments.md#capture-payment) 9. (Optional) [Examine payments collected offline](https://docs.stripe.com/terminal/features/operate-offline/collect-card-payments.md#examine-offline) ## Enable offline mode To use offline mode, your application needs to consume version `3.2.0` or later of the Terminal Android SDK. Use a [Configuration](https://docs.stripe.com/api/terminal/configuration.md) object or [the Dashboard](https://docs.stripe.com/terminal/fleet/configurations-overview.md?dashboard-or-api=dashboard#update-the-default-configuration-for-the-account) to enable offline mode for the [supported](https://docs.stripe.com/terminal/features/operate-offline/overview.md?reader-type=internet#availability) devices at your `Location`. ```curl curl https://api.stripe.com/v1/terminal/configurations \ -u "<>:" \ -d "offline[enabled]=true" ``` After you enable offline mode on a `Configuration` object, you can [assign it](https://docs.stripe.com/terminal/fleet/configurations-overview.md?dashboard-or-api=api#create-a-configuration-for-an-individual-location) to a `Location`. You can also enable offline mode by default for all `Locations` by updating the [default](https://docs.stripe.com/terminal/fleet/configurations-overview.md?dashboard-or-api=api#retrieve-the-account-default-configuration) `Configuration` object for your account. Configuration API changes can take several minutes to propagate to your SDK and reader, and require you to disconnect from and reconnect to your reader to take effect. ## Connect to a reader while offline The reader stores necessary `Location` information locally after connecting online. On subsequent offline connections, it uses the stored configuration information from that `Location`. To collect payments with a smart reader while offline, you must have previously connected to the same reader using a valid connection token within the last 24 hours, on the same local network. The reader stores the `Location` information locally after connecting online, and it derives configuration information from that `Location` while operating offline. Your reader and POS device must be on the same local network used to connect online. You can’t switch networks while offline. If you attempt to connect to a reader while offline without meeting these requirements, the request fails with an error. | Error | Resolution | | ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **The SDK isn’t connected to the internet** | Make sure the `Location` you’re using is [configured](https://docs.stripe.com/terminal/features/operate-offline/collect-card-payments.md#enable-offline-mode) for offline mode. Otherwise, connect to any reader while online, and then connect to a reader of the same type while offline. | | **The selected reader requires a software update before it can be used to collect payments offline.** | The reader’s software hasn’t been updated in 30 days or more. Connect to the reader while online to update it. | | **The selected reader must be paired online at this location before it can be used to collect payments offline.** | You’re attempting to connect to a reader type that your POS hasn’t previously connected to while online. You must first connect to this reader or any reader of the same type while online. Or, if you want to connect while offline, you can connect to a reader type that your POS previously connected to while online. | #### Connection token provider behavior while offline When your POS is offline, the SDK still calls your connection token provider to fetch a connection token. Because your backend won’t be reachable in offline scenarios, your connection token provider should call `onFailure` immediately to allow the SDK to proceed with offline operations. ## Handle offline events [Client-side] - [OfflineListener (Android)](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-offline-listener/index.html) To allow your application to receive updates about the SDK’s network status and the state of forwarded payments, implement the `OfflineListener` interface and pass it to the Terminal SDK. You must set `OfflineListener` before collecting payments offline. #### Kotlin ```kotlin class CustomOfflineListener : OfflineListener { override fun onOfflineStatusChange(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::offlineStatus`. } override fun onPaymentIntentForwarded(paymentIntent: PaymentIntent, e: TerminalException?) { // The PaymentIntent was successfully forwarded, or an error occurred. // Reconcile any local state using the backend-generated `PaymentIntent::id` // and the metadata you supplied when creating the PaymentIntent. // // Note that the `PaymentIntent::id` may still be null if creating the // PaymentIntent in the backend failed. } override fun onForwardingFailure(e: TerminalException) { // A non-specific error occurred while forwarding a PaymentIntent. // Check the error message and your integration implementation to // troubleshoot. } } ``` #### Kotlin ```kotlin Terminal.init( context = applicationContext, logLevel = LogLevel.VERBOSE, tokenProvider = CustomConnectionTokenProvider(), listener = CustomTerminalListener(), offlineListener = CustomOfflineListener(), ) ``` ## Create a PaymentIntent while offline [Client-side] - [createPaymentIntent (Android)](https://stripe.dev/stripe-terminal-android/core/com.stripe.stripeterminal/-terminal/create-payment-intent.html) - [CreateConfiguration (Android)](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.models/-create-configuration/index.html) - [OfflineDetails (Android)](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.models/-offline-details/index.html) To support operating offline, use the SDK’s `createPaymentIntent` to create PaymentIntent objects. This allows the SDK to create PaymentIntents while offline and forward them to Stripe after you’ve re-established connectivity. While operating offline, `PaymentIntent` objects have a null `id`. We recommend adding a custom identifier to the PaymentIntent’s [metadata](https://docs.stripe.com/payments/payment-intents.md#storing-information-in-metadata) to help reconcile `PaymentIntent` objects created offline in your database. You can set up a [webhook](https://docs.stripe.com/webhooks.md) endpoint to receive `PaymentIntent` events when offline payments are forwarded to Stripe, and use your identifier to associate them with a `PaymentIntent` ID. #### Kotlin ```kotlin private const val TAG = "PaymentActivity" class PaymentActivity : AppCompatActivity() { // Action for a "Checkout" button private fun onCheckout(cart: Cart) { // Build up parameters for creating a `PaymentIntent` val params = PaymentIntentParameters.Builder() .setAmount(cart.total) .setCurrency(cart.currency) .setMetadata(mapOf("unique-id" to UUID.randomUUID().toString())) .build() val createPaymentCallback: PaymentIntentCallback = object : PaymentIntentCallback { override fun onSuccess(paymentIntent: PaymentIntent) { Log.d(TAG, "createPaymentIntent succeeded") // If the `PaymentIntent` was created offline, its `id` field will be null. if (paymentIntent.id != null) { Log.d(TAG, "created online") } else { Log.d(TAG, "created offline") } // ... Collect a PaymentMethod } override fun onFailure(e: TerminalException) { Log.e(TAG, "createPaymentIntent failed", e) // Handle errors in your application. } } Terminal.getInstance().createPaymentIntent(params, createPaymentCallback) } } ``` The `Terminal.createPaymentIntent` accepts a `CreateConfiguration` parameter. By default, if you’re operating offline, the Terminal SDK stores all offline payments, then forwards them to Stripe’s backend when connectivity is restored. To customize this behavior, you can pass in a `CreateConfiguration` object with an `offlineBehavior` attribute set to as `REQUIRE_ONLINE`, `PREFER_ONLINE` or `FORCE_OFFLINE`. #### Managing risk Setting `offlineBehavior` to `REQUIRE_ONLINE` fails the current transaction if you’re operating offline. For example, you might want to disallow transactions above a certain amount or disallow all offline transactions if the reader has stored a set of transactions whose sum exceeds a certain amount. The SDK exposes two properties to help you manage risk: 1. `Terminal.offlineStatus.reader.offlinePaymentsCount` 2. `Terminal.offlineStatus.reader.offlinePaymentAmountsByCurrency` #### Managing latency while offline Based on your network connectivity, the Terminal SDK automatically determines whether to collect payments online or offline. However, you might want to operate offline despite having an active network connection (for example, if you need to collect transactions quickly and your network connection is slow). You can pass a `CreateConfiguration` object with `offlineBehavior` set to `FORCE_OFFLINE` to collect the payment offline regardless of connectivity. Payments collected offline while the Terminal reader has an active network connection are forwarded in the background. #### Kotlin ```kotlin private const val TAG = "PaymentActivity" class PaymentActivity : AppCompatActivity() { // Action for a "Checkout" button private fun onCheckout(cart: Cart) { // ...build up parameters and callback for creating a `PaymentIntent` // Your app might want to prevent offline payments for too large an amount. // Here, we require a network connection if the payment if the amount is over 1000 usd. // Otherwise, we allow collecting offline if the network connection is unavailable. val offlineBehavior = if (cart.total > 1000000) { OfflineBehavior.REQUIRE_ONLINE } else { OfflineBehavior.PREFER_ONLINE } val createConfig = CreateConfiguration(offlineBehavior) Terminal.getInstance().createPaymentIntent(params, createPaymentCallback, createConfig) } } ``` ## Collect a payment method [Client-side] - [CollectPaymentIntentConfiguration (Android)](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.models/-collect-payment-intent-configuration/index.html) > Payment liability is your responsibility when operating your reader offline. Because magnetic stripe data is easy to spoof, Stripe disallows this option while operating offline. Tapping cards is also not supported in markets where *Strong Customer Authentication* (Strong Customer Authentication (SCA) is a regulatory requirement in effect as of September 14, 2019, that impacts many European online payments. It requires customers to use two-factor authentication like 3D Secure to verify their purchase) is required. Collecting payments while offline is similar to [collecting payments while online](https://docs.stripe.com/terminal/payments/collect-card-payment.md?process=inspect#collect-payment). Your smart reader automatically displays the available payment options to the customer. > Readers don’t support [inspecting payment method details before authorization](https://docs.stripe.com/terminal/payments/collect-card-payment.md?terminal-sdk-platform=android#collect-inspect-payment-method) while offline. Although you can still set the `updatePaymentIntent` parameter in `CollectPaymentIntentConfiguration`, the `paymentMethod` field on the PaymentIntent is absent if the SDK is operating offline. #### Kotlin ```kotlin private const val TAG = "PaymentActivity" class PaymentActivity : AppCompatActivity() { // Action for a "Checkout" button private fun onCheckout(cart: Cart) { val collectPaymentCallback: PaymentIntentCallback = object : PaymentIntentCallback { override fun onSuccess(paymentIntent: PaymentIntent) { Log.d(TAG, "collectPaymentMethod succeeded") // ... Confirm the payment } override fun onFailure(e: TerminalException) { Log.d(TAG, "collectPaymentMethod failed:", e) } } val collectConfig = CollectPaymentIntentConfiguration.Builder().build() Terminal.getInstance().collectPaymentMethod(paymentIntent, collectPaymentCallback, collectConfig) } } ``` ## Confirm payment [Client-side] Confirming payments while offline is similar to [confirming payments while online](https://docs.stripe.com/terminal/payments/collect-card-payment.md?process=inspect#confirm-payment). The primary difference is that your integration must handle offline-specific error cases, such as when the transaction exceeds the Stripe-enforced offline maximum of 10,000 USD or equivalent in your operating currency. In some cases, the SDK might create a `PaymentIntent` online, but confirm it while offline. When this happens, the `PaymentIntent` might have a non-null `id`. If it was confirmed offline, `offlineDetails` will be defined and populated. #### Kotlin ```kotlin private const val TAG = "PaymentActivity" class PaymentActivity : AppCompatActivity() { // Action for a "Checkout" button private fun onCheckout(cart: Cart) { val confirmPaymentIntentCallback: PaymentIntentCallback = object : PaymentIntentCallback { override fun onSuccess(paymentIntent: PaymentIntent) { Log.d(TAG, "confirmPaymentIntent succeeded") // If the `PaymentIntent` was confirmed offline, `paymentIntent.offlineDetails` will be defined if (paymentIntent.offlineDetails != null) { Log.d(TAG, "confirmed offline") } else { Log.d(TAG, "confirmed online") } } override fun onFailure(e: TerminalException) { // Handle offline-specific errors in your application (for example, // unsupported payment method). Log.e(TAG, "confirmPaymentIntent failed:", e) } } Terminal.getInstance().confirmPaymentIntent(paymentIntent, confirmPaymentIntentCallback) } } ``` #### Providing receipts You might require information about the card used to complete a payment while offline. For example, you might need to generate a receipt for customers who require one at the time of purchase. If the PaymentIntent is confirmed offline, retrieve its [OfflineCardPresentDetails](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.models/-offline-card-present-details/index.html) from the `paymentIntent.offlineDetails.offlineCardPresentDetails` property. This hash contains a [ReceiptDetails](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.models/-receipt-details/index.html) property you can use to generate a receipt, as well as other card details like the cardholder name and card brand. The `account_type` and `authorization_response_code` receipt fields are unavailable on PaymentIntents processed offline. [Prebuilt email receipts](https://docs.stripe.com/terminal/features/receipts.md#prebuilt) are only sent after connectivity is restored and the payment is successfully captured. ## Wait for payments to forward [Client-side] When network connectivity is restored, the reader automatically begins forwarding the stored offline payments. The reader attempts to forward payments even if its network status is offline. This means your connection token provider might receive a request to provide a connection token even when the device is offline. If you disconnect or power off your smart reader too soon, your payments might not be forwarded. You can query `Terminal.offlineStatus.reader.networkStatus` to make sure your reader is online and can forward payments, and `Terminal.offlineStatus.reader.offlinePaymentsCount` to check how many payments the reader has to be forwarded. If your smart reader becomes damaged or otherwise can’t take payments, your stored payments can often still be forwarded. Make sure to connect the smart reader to your POS and re-establish Internet access to allow it to re-connect to Stripe. ## Capture payment While offline, you can create PaymentIntents with `captureMethod` set to `automatic`. After you confirm these PaymentIntents, they have a `SUCCEEDED` status instead of `REQUIRES_CAPTURE` . Stripe automatically captures the payments after you forward them. If you opt for manual capture, payments that are successfully forwarded and authorized require capture from your backend or application. - To capture payments from your backend, use [webhooks](https://docs.stripe.com/webhooks.md) to listen for PaymentIntents with a `requires_capture` status. - To capture payments from your application, wait for your application to receive calls to `OfflineListener::onPaymentIntentForwarded` for each PaymentIntent as the reader forwards it. A PaymentIntent is ready to capture if its status is `REQUIRES_CAPTURE` and the `offlineDetails` is null or has a `requiresUpload` value of `false` . #### Kotlin ```kotlin private const val TAG = "PaymentActivity" class PaymentActivity : AppCompatActivity() { // Action for a "Checkout" button private fun onCheckout(cart: Cart) { val callback: PaymentIntentCallback = object : PaymentIntentCallback { override fun onSuccess(paymentIntent: PaymentIntent) { Log.d(TAG, "confirmPaymentIntent succeeded") if (paymentIntent.status == PaymentIntentStatus.REQUIRES_CAPTURE) { val offlineDetails = paymentIntent.offlineDetails if (offlineDetails?.requiresUpload == true) { // Offline payment, wait for `onPaymentIntentForwarded` (see snippet below) } else { // Online payment, can be captured now } } else { // Handle other status results here } } override fun onFailure(e: TerminalException) { // Handle offline-specific errors in your application (for example, // unsupported payment method). Log.e(TAG, "confirmPaymentIntent failed:", e) } } Terminal.getInstance().confirmPaymentIntent(paymentIntent, callback) } } ``` Capture an offline payment after the reader forwards it in your `OfflineListener::onPaymentIntentForwarded`: #### Kotlin ```kotlin class CustomOfflineListener : OfflineListener { // ... override fun onPaymentIntentForwarded(paymentIntent: PaymentIntent, e: TerminalException?) { if (e != null) { // Handle the error appropriate for your application } else if (paymentIntent.status == PaymentIntentStatus.REQUIRES_CAPTURE) { // The paymentIntent is ready to be captured } else { // Handle other status results here } } // ... } ``` ## Examine payments collected offline After authorization, you can use the [PaymentIntents](https://docs.stripe.com/payments/payment-intents.md) API to examine offline details on a payment. Access the [payment method details](https://docs.stripe.com/api/charges/object.md#charge_object-payment_method_details-card_present-offline) on the [latest Charge](https://docs.stripe.com/api/payment_intents/object.md#payment_intent_object-latest_charge) object on a `PaymentIntent` to determine if it was collected offline. > You can’t cancel or refund a PaymentIntent that was created and confirmed offline until it’s forwarded to Stripe.