Skip to content

Releases

5.8.1

Choose a tag to compare

@henryx-stripe henryx-stripe released this 09 Oct 00:18

5.8.1 2026-10-08

Fixes

  • Fixed an issue where offline PaymentIntents dropped merchant-supplied creation parameters, causing Tap to Pay on iPhone collection to fail for destination charges using onBehalfOf.

6.0.0

Choose a tag to compare

@henryx-stripe henryx-stripe released this 07 Oct 18:31

6.0.0 2026-10-07

  • Built with Xcode 27.0, Swift version 6.4.
  • The framework is built with -Xfrontend -disable-module-selectors-in-module-interface, so the public .swiftinterface uses the pre-6.3 dot-qualified spelling instead of the SE-0491 Module::Type selector syntax Swift 6.3+ emits by default. Minimum requirement for integrators: Xcode 16.0+, Swift 6.0+.

New

  • WisePad 3 now supports amount surcharge and confirm-time on-reader surcharge consent. Collect-time surchargeNotice remains unsupported on WisePad 3.
  • Added SCPErrorCanceledByReader, returned when an operation is canceled on the reader: the physical cancel button on a mobile reader, or the customer canceling on a smart reader. Programmatic cancellations initiated through the SDK continue to return SCPErrorCanceled.
  • Tap to Pay on iPhone now returns SCPErrorCanceledByReader when the customer dismisses the payment sheet or backs out of PIN entry. Cancellations the integration requests through SCPCancelable continue to return SCPErrorCanceled.
  • Added SCPPaymentMethodCardPresentDetails, which exposes the instrument fields returned by payment_method.card_present and payment_method.interac_present, including available and preferred card networks.
  • Added latestCharge and latestChargeId to SCPPaymentIntent, exposing the PaymentIntent's most recent Charge from either latest_charge or the legacy charges list.
  • Preview: Refunds - Added confirmRefund, which creates a Refund for a PaymentIntent without collecting a payment method or displaying reader UI.
    • Added SCPConfirmRefundParameters to configure full or partial refunds and optional Refund fields.
    • Added SCPRefundStatusCanceled and SCPRefundStatusRequiresAction.
    • Added SCPRefundNextAction to expose required follow-up details.
    • To request access to this feature, please contact Stripe Support.
  • Preview: Added support for Mexico installments (meses sin intereses, or MSI) for eligible card-present transactions. Use SCPInstallmentsParametersBuilder to enable installments when creating a PaymentIntent. After payment method collection, SCPInstallmentsParameters.availablePlans contains the eligible installment plans. After confirmation, SCPInstallmentsParameters.plan contains the plan selected by the cardholder.
  • Preview: Swish — Added SCPPaymentMethodTypeSwish and SCPSwishDetails, and exposed Swish details through SCPPaymentMethod.swish and SCPPaymentMethodDetails.swish.

Updates

  • Breaking: SCPRefund.stripeId now returns a nullable string. In Swift, Refund.stripeId is now String?. Check for a value before using it.
  • Breaking: Standardized the PaymentMethod properties on SCPSetupIntent to match SCPPaymentIntent. The expanded SCPPaymentMethod is now exposed as paymentMethod, and its ID is exposed as paymentMethodId. Replace uses of the previous ID-valued paymentMethod property with paymentMethodId, and replace paymentMethodExpanded with paymentMethod.
  • Breaking: Removed SCPPaymentIntent.charges. Use latestCharge for the expanded most recent Charge and latestChargeId for its ID.
  • Breaking: Removed SCPPaymentIntent.invoice. Retrieve the PaymentIntent's invoice relationship through the Stripe API from your server.
  • Breaking: SCPPaymentMethod.cardPresent and SCPPaymentMethod.interacPresent now return SCPPaymentMethodCardPresentDetails instead of SCPCardPresentDetails. Transaction-only properties remain on SCPPaymentMethodDetails.cardPresent and SCPPaymentMethodDetails.interacPresent. SCPCardPresentDetails.networks has been removed; use the corresponding SCPPaymentMethodCardPresentDetails.networks property instead. Expiration month and year on the new model are nullable to preserve their absence in API responses.
  • Breaking: Removed SCPCardBrand (CardBrand). The brand properties on
    SCPCardDetails, SCPCardPresentDetails, and SCPOfflineCardPresentDetails
    are now strings. SCPCardPresentDetails.network and the entries in
    SCPNetworks.available are also strings, and SCPNetworks.preferred now
    exposes the API's preferred network. Replace enum comparisons such as .visa
    with string comparisons such as "visa".
  • Breaking: Replaced SCPErrorPrinterLowBattery with the more general SCPErrorReaderBatteryLow, returned when a reader remains connected but cannot complete an operation, such as printing, because its battery is too low.
  • Breaking: Removed SCPCardFundingType (CardFundingType). The funding
    properties on SCPCardDetails (CardDetails) and SCPCardPresentDetails
    (CardPresentDetails) are now nullable strings containing the value returned
    by the Stripe API. Replace enum comparisons such as .credit with string
    comparisons such as "credit". Missing funding values are returned as nil,
    and values introduced after the installed SDK version are preserved.
  • Breaking: Removed SCPTerminal.stringFromCardBrand: (Terminal.stringFromCardBrand).
    brand values are now strings directly, so no conversion is necessary.
  • Breaking: Removed SCPReadMethod (ReadMethod). The readMethod
    properties on SCPCardPresentDetails (CardPresentDetails) and
    SCPOfflineCardPresentDetails (OfflineCardPresentDetails) are now strings
    containing canonical Stripe API values such as "contact_emv". Values
    introduced after the installed SDK version are preserved, and missing values
    are returned as "unknown".
  • Breaking: Removed SCPTerminal.stringFromReadMethod:
    (Terminal.stringFromReadMethod). readMethod values are now strings
    directly, so no conversion is necessary.
  • Breaking: Removed SCPErrorSimulatedOfflineModeNotAvailableForAccount.
    Simulated offline mode is now generally available and is no longer gated
    per-account, so this error is never returned.
    setSimulatedOfflineModeConfiguration:error: no longer fails when a reader is
    connected, and connecting a testmode reader no longer disconnects it for
    lacking access. Remove any handling for this error code. Connecting to a
    livemode reader still returns
    SCPErrorSimulatedOfflineModeNotAvailableInLivemode.
  • Breaking: SCPPaymentIntentParametersBuilder now defaults captureMethod to SCPCaptureMethodAutomaticAsync instead of SCPCaptureMethodManual. Integrations that require separate capture, including those using on-receipt tipping, incremental authorization, or extended authorization, must explicitly set SCPCaptureMethodManual.
  • Breaking: allowRedisplay is now required when initializing CollectSetupIntentConfigurationBuilder, and all SetupIntent collection and processing methods require a CollectSetupIntentConfiguration. In Swift, migrate from CollectSetupIntentConfigurationBuilder() to CollectSetupIntentConfigurationBuilder(allowRedisplay: .always) (or another appropriate value), then pass the built configuration as setupConfig to collectSetupIntentPaymentMethod or as collectConfig to processSetupIntent.
  • Breaking: Renamed SCPRefundParameters (RefundParameters) and SCPRefundParametersBuilder (RefundParametersBuilder) to SCPProcessRefundParameters (ProcessRefundParameters) and SCPProcessRefundParametersBuilder (ProcessRefundParametersBuilder). Update integrations that call processRefund to use the new names. Refund behavior is unchanged.
  • Breaking: Added ReaderInteractionDelegate as the shared base protocol for MobileReaderDelegate and TapToPayReaderDelegate. The five reader lifecycle and display callbacks shared by Mobile Reader and Tap to Pay now use the reader method prefix, allowing integrations that support both reader types to implement these callbacks once.
    • Rename the five required Swift callbacks from tapToPayReader(_:didStartInstallingUpdate:cancelable:), tapToPayReader(_:didReportReaderSoftwareUpdateProgress:), tapToPayReader(_:didFinishInstallingUpdate:error:), tapToPayReader(_:didRequestReaderInput:), and tapToPayReader(_:didRequestReaderDisplayMessage:) to their corresponding reader(_: forms. In Objective-C, rename the corresponding selectors from tapToPayReader:didStartInstallingUpdate:cancelable:, tapToPayReader:didReportReaderSoftwareUpdateProgress:, tapToPayReader:didFinishInstallingUpdate:error:, tapToPayReader:didRequestReaderInput:, and tapToPayReader:didRequestReaderDisplayMessage: to selectors beginning with reader:.
    • Payment callbacks are not part of ReaderInteractionDelegate. Mobile Reader and Tap to Pay connections use the separate ReaderPaymentInteractionDelegate.reader(_:didRequestInteraction:) callback and PaymentInteraction wrapper types for blocking payment UI. Set the delegate on the connection configuration with setReaderPaymentInteractionDelegate(_:).
    • The update API split is intentional: MobileReaderDelegate.reader(_:didReportAvailableUpdate:) reports a deferred optional update whose installation is user-triggered for Mobile Readers, while the shared installation callbacks also report mandatory Tap to Pay configuration installation during connection. Tap to Pay doesn't report available optional updates.
  • Breaking: Removed allowCustomerCancel and setAllowCustomerCancel: from SCPInternetConnectionConfiguration. Customer-initiated cancellation is controlled per-collection by [customerCancellation](https://stripe.dev/stripe-terminal-ios/docs/Classes/SCPCollectPaymentIntentConfigu...
Read more

5.8.0

Choose a tag to compare

@nk-stripe nk-stripe released this 18 Aug 19:27

New

  • Added support for reading and setting the buzzer volume on supported readers.
    • Read the current volume from SCPReaderSettings.buzzerVolume via retrieveReaderSettings:. SCPReaderBuzzerVolume reports the current and maximum volume.
    • Set the volume by calling setReaderSettings:completion: with SCPBuzzerVolumeParameters, using init(level:) for Low or High, or init(volume:) for a custom volume in the range 1...maxVolume.
    • On a connected reader that does not support buzzer volume control, the volume is reported as unavailable and setReaderSettings: fails.
  • Added generatedCardExpanded property to SCPSetupAttemptCardPresentDetails, exposing the full SCPPaymentMethod object when saving a card via SetupIntent. Fixes #392.
  • Added paymentMethodExpanded property to SCPSetupIntent, exposing the full SCPPaymentMethod object attached to the SetupIntent.
  • Added SCPLogLevelError, SCPLogLevelWarning, and SCPLogLevelInfo to SCPLogLevel, matching the granularity available in the Android SDK. Setting a level now prints logs at that severity and above, rather than all-or-nothing.
  • Added SCPErrorPrinterLowBattery error code. This error is returned when the reader's battery is too low to complete a print operation.
  • Added SCPDeviceTypeUnknown (DeviceType.unknown). A reader whose device_type this version of the SDK does not recognize is now surfaced with this device type instead of being omitted, mirroring the Android SDK. The SDK exposes no known capabilities for a reader of this type.

Fixes

5.7.0

Choose a tag to compare

@bric-stripe bric-stripe released this 13 Jul 17:30

5.7.0 2026-07-13

New

  • Preview: Surcharging - Added support for collecting surcharges on Tap to Pay on iPhone readers.

Fixes

5.6.0

Choose a tag to compare

@henryx-stripe henryx-stripe released this 08 Jun 18:12

5.6.0 2026-06-08

New

  • Added SCPCardPresentDetails.overcaptureStatus to indicate whether overcapture is supported for a card present transaction. Fixes #386.
    • Note for internet reader integrations, this feature requires reader software version 2.43 or later to be installed on your internet reader.
  • Added SCPLocaleConfig parameter to Terminal.initWithTokenProvider to configure localization of API error messages. Pass LocaleConfig.cardLanguagePreferenceIfAvailable to localize messages to the cardholder's preferred language when available (falling back to the device locale), or HardcodedLocaleConfig for a fixed locale.

Fixes

  • Fixes #378: Fixed a crash caused by a race condition during internal logging operations.
  • Preview: Surcharging - Fixed an issue where SCPSurchargeDetails.amount was not included in the amount charged, also causing an incorrect maximumAmount calculation.
  • Fixes a race condition in where the reader state could be mutated after a disconnect, leaving the SDK permanently stuck in the Connected state.

5.5.0

Choose a tag to compare

@bric-stripe bric-stripe released this 04 May 20:29

5.5.0 2026-05-04

New

  • Preview: Surcharging - Refactored the surcharge API surface.
    • Added new SCPSurchargeDetails class with amount, maximumAmount, and status on SCPAmountDetails.surcharge.
    • Breaking: SCPSurcharge class (under SCPCardPresentParameters) has been removed. Use SCPSurchargeDetails for maximumAmount and status. status is now a SCPSurchargeStatus enum instead of NSString.
    • Breaking: SCPPaymentIntent.amountSurcharge (top-level) has been removed. Use SCPAmountDetails.surcharge.amount instead.
    • To request access to this feature, please contact Stripe Support.
  • Tap to Pay: Added method isTapToPayAccountLinked, which checks if the current Stripe account has a linked Tap to Pay on iPhone account that has accepted the Apple Tap to Pay Terms of Service.
  • Added simulated offline mode support for testing offline payment flows without a physical network disruption. The simulation capability is currently in preview.
    • Added simulatedOfflineModeConfiguration property and setSimulatedOfflineModeConfiguration:error: method to SCPTerminal.
    • Added SCPSimulatedOfflineModeConfiguration and SCPSimulatedOfflineModeConfigurationBuilder to configure SDK and reader offline behavior independently.
    • Added SCPSimulatedOfflineMode enum with values: disabled, offlineImmediate, offlineTimeout, and offlineIntermittent.
    • Returns SCPErrorSimulatedOfflineModeNotAvailableForAccount if you do not have access, and SCPErrorSimulatedOfflineModeNotAvailableInLivemode if connected to a livemode reader.
    • To request access to this feature, please contact Stripe Support.
  • Added support for simulating software update scenarios on physical mobile readers in test mode.

Updates

  • When offline mode is enabled, the SDK now falls back to offline processing faster when the device can't reach Stripe. Previously, the SDK waited up to 15 seconds before falling back. Now, timeouts are optimized per request type, reducing wait times for common operations like payment creation.
  • Tap to Pay: Generic or unknown errors from the Tap to Pay on iPhone reader will now return SCPErrorGenericReaderError instead of SCPErrorUnexpectedSdkError.

Fixes

  • Fixes #374: Fixed a race condition that could cause a crash during mobile reader discovery over Bluetooth.

5.4.0

Choose a tag to compare

@bric-stripe bric-stripe released this 30 Mar 22:17

5.4.0 2026-03-30

New

  • Preview: Terminal Donations - Added support to skip donations flow per transaction by adding a skipDonation parameter to the SCPCollectPaymentIntentConfiguration model.
    • To request access to this private preview, please contact Stripe Support.
  • Preview: Multi Capture - Added requestMulticapture to SCPCardPresentParameters for requesting multicapture support when creating card-present PaymentIntents.
  • Preview: Reauthorizations - Added support to authorize a PaymentIntent again after its capture window has lapsed.
    • Added requestReauthorization to SCPCardPresentParameters for requesting reauthorization support when creating card-present PaymentIntents.
    • Added reauthorizationStatus and reauthorizeBefore response fields to SCPCardPresentDetails.
    • Added SCPPaymentIntentStatusRequiresReauthorization to SCPPaymentIntentStatus.
    • To request access to this feature, please contact Stripe Support.
  • Added the captureBefore response field to SCPCardPresentDetails.
    • Previously only available via the server-side API.

Updates

Fixes

  • Fixes #377: Fixed a crash caused by delegate callbacks and completion handlers being dispatched on background threads when using Swift concurrency.
  • Fixed a crash that could occur during reader discovery.

5.3.0

Choose a tag to compare

@henryx-stripe henryx-stripe released this 03 Mar 20:37

5.3.0 2026-03-03

Fixes

  • Fixes #370: Fixed a race condition that could cause a crash when connecting to readers.

5.2.0

Choose a tag to compare

@nk-stripe nk-stripe released this 27 Jan 21:39

New

  • Added support for tip-eligibility on WisePad 3 devices, allowing configuration of the portion of a transaction amount on which tips are calculated.

  • Added SCPErrorConfirmInvalidSetupIntent error code to properly identify invalid SetupIntent confirmation attempts.

  • Added support for collecting surcharges on M2 devices.

  • Added Tap to Pay support for QR-based non‑card payments. TapToPayReaderDelegate has two new callbacks you must implement to enable this:

    • tapToPayReader:didRequestPaymentMethodSelection:availablePaymentOptions:completion to allow your application to choose the payment method type the customer wants.
    • tapToPayReader:didRequestQrCodeDisplay:qrData:completion: to display the QR code.
    • To request access to this feature, please contact Stripe Support.

Updates

  • When connecting to a Tap to Pay on iPhone reader, the SDK now validates device compatibility before making any API calls. Incompatible devices will return an error consistent with supportsReadersOfType.
  • Improved Tap to Pay error handling on the connectReader function. If the app is backgrounded during an Apple proximity reader update, the connection failure is now returned when the app returns to the foreground, rather than being returned immediately.

Fixes

  • Fixes an issue where the Tap to Pay reader reconnection fails when the app comes to the foreground, caused by an internal race condition.

5.1.1

Choose a tag to compare

@bric-stripe bric-stripe released this 24 Dec 17:13
  • Built with Xcode 26.0 Swift version 6.2.

Fixes

  • Fixes a crash that could occur during disconnectReader with internet readers.