SCPError

Objective-C

enum SCPError : NSInteger {}

Swift

typealias ErrorCode.Code._ErrorType = ErrorCode

Possible error codes for NSError objects under the SCPErrorDomain domain.

  • Canceling a command failed because the command already completed.

    Declaration

    Objective-C

    SCPErrorCancelFailedAlreadyCompleted = 1010

    Swift

    static var cancelFailedAlreadyCompleted: ErrorCode.Code { get }

  • Canceling a command failed because the command cannot currently be canceled.

    Declaration

    Objective-C

    SCPErrorCancelFailedUnavailable = 1011

    Swift

    static var cancelFailedUnavailable: ErrorCode.Code { get }

  • No reader is connected. Connect to a reader before trying again.

    Declaration

    Objective-C

    SCPErrorNotConnectedToReader = 1100

    Swift

    static var notConnectedToReader: ErrorCode.Code { get }

  • Already connected to a reader.

    Declaration

    Objective-C

    SCPErrorAlreadyConnectedToReader = 1110

    Swift

    static var alreadyConnectedToReader: ErrorCode.Code { get }

  • Your implementation of fetchConnectionToken called the completion block with (nil, nil). Please make sure your integration completes with either a connection token or an error.

    Declaration

    Objective-C

    SCPErrorConnectionTokenProviderCompletedWithNothing = 1510

    Swift

    static var connectionTokenProviderCompletedWithNothing: ErrorCode.Code { get }

  • Error reported while forwarding offline payments when the connection token provider neither returns a token nor an error.

    Declaration

    Objective-C

    SCPErrorConnectionTokenProviderCompletedWithNothingWhileForwarding = 1511

    Swift

    static var connectionTokenProviderCompletedWithNothingWhileForwarding: ErrorCode.Code { get }

  • confirmPaymentIntent was called with an unknown or invalid PaymentIntent. You must confirm a payment immediately after collecting a payment method.

    Declaration

    Objective-C

    SCPErrorConfirmInvalidPaymentIntent = 1530

    Swift

    static var confirmInvalidPaymentIntent: ErrorCode.Code { get }

  • collectPaymentMethod or confirmPaymentIntent was called with a nil PaymentIntent.

    Declaration

    Objective-C

    SCPErrorNilPaymentIntent = 1540

    Swift

    static var nilPaymentIntent: ErrorCode.Code { get }

  • collectSetupIntentPaymentMethod or confirmSetupIntent was called with a nil SetupIntent.

    Declaration

    Objective-C

    SCPErrorNilSetupIntent = 1542

    Swift

    static var nilSetupIntent: ErrorCode.Code { get }

  • confirmRefund was called without calling collectRefundPaymentMethod beforehand.

    Declaration

    Objective-C

    SCPErrorNilRefundPaymentMethod = 1550

    Swift

    static var nilRefundPaymentMethod: ErrorCode.Code { get }

  • The RefundParameters object has invalid values. The Charge ID (ch_123abc) or PaymentIntent ID (pi_123abc) can be found on the PaymentIntent object, which you should get from your backend. You must have only one of a charge or payment intent ID set.

    Declaration

    Objective-C

    SCPErrorInvalidRefundParameters = 1555

    Swift

    static var invalidRefundParameters: ErrorCode.Code { get }

  • A PaymentIntent or SetupIntent was referenced using an invalid client secret.

    Declaration

    Objective-C

    SCPErrorInvalidClientSecret = 1560

    Swift

    static var invalidClientSecret: ErrorCode.Code { get }

  • discoverReaders was called using an invalid SCPDiscoveryConfiguration. Your app selected a discovery method that is either incompatible with the selected device type or attemped to use simulated or locationId with a reader which does not support simulated or locationId. Currently chipper2X is the only reader which supports simulated and verifoneP400 is the only reader which supports use of locationId for location filtering.

    See

    SCPDiscoveryConfiguration for valid configurations.

    Declaration

    Objective-C

    SCPErrorInvalidDiscoveryConfiguration = 1590

    Swift

    static var invalidDiscoveryConfiguration: ErrorCode.Code { get }

  • connectReader was called using an invalid SCPConnectionConfiguration. Your app provided a connection configuration that is incompatible with the selected reader.

    See

    SCPConnectionConfiguration for valid configurations.

    Declaration

    Objective-C

    SCPErrorInvalidConnectionConfiguration = 1591

    Swift

    static var invalidConnectionConfiguration: ErrorCode.Code { get }

  • installUpdate was passed an update that is for a different reader. Updates can only be installed on the reader that was connected when the update was announced.

    Declaration

    Objective-C

    SCPErrorInvalidReaderForUpdate = 1861

    Swift

    static var invalidReaderForUpdate: ErrorCode.Code { get }

  • -[SCPTerminal connectReader:completion:] was called from an unsupported version of the SDK. In order to fix this you will need to update your app to the most recent version of the SDK. We suggest you prompt your user to update their app, assuming there is an update app version with a supported version of our SDK.

    See

    https://github.com/stripe/stripe-terminal-ios/releases/latest

    Declaration

    Objective-C

    SCPErrorUnsupportedSDK = 1870

    Swift

    static var unsupportedSDK: ErrorCode.Code { get }

  • This feature is currently not available for the selected reader.

    Declaration

    Objective-C

    SCPErrorFeatureNotAvailableWithConnectedReader = 1880

    Swift

    static var featureNotAvailableWithConnectedReader: ErrorCode.Code { get }

  • This feature is not currently available. More details available in the error’s userInfo in the SCPErrorKeyMessage key

    Declaration

    Objective-C

    SCPErrorFeatureNotAvailable = 1890

    Swift

    static var featureNotAvailable: ErrorCode.Code { get }

  • The ListLocationsParameters object has invalid values.

    Declaration

    Objective-C

    SCPErrorInvalidListLocationsLimitParameter = 1900

    Swift

    static var invalidListLocationsLimitParameter: ErrorCode.Code { get }

  • The locationId parameter to BluetoothConnectionConfiguration is required but a valid one was not provided.

    Declaration

    Objective-C

    SCPErrorBluetoothConnectionInvalidLocationIdParameter = 1910

    Swift

    static var bluetoothConnectionInvalidLocationIdParameter: ErrorCode.Code { get }

  • A required parameter was invalid or missing.

    Declaration

    Objective-C

    SCPErrorInvalidRequiredParameter = 1920

    Swift

    static var invalidRequiredParameter: ErrorCode.Code { get }

  • The PaymentIntent uses on_behalf_of but the Connected Account ID was not set in SCPTapToPayConnectionConfiguration: https://stripe.com/docs/terminal/payments/connect-reader?terminal-sdk-platform=ios&reader-type=tap-to-pay#connect-reader

    Declaration

    Objective-C

    SCPErrorInvalidRequiredParameterOnBehalfOf = 1921

    Swift

    static var invalidRequiredParameterOnBehalfOf: ErrorCode.Code { get }

  • Error reported when forwarding stored offline payments. The fetched connection token was generated with a different account ID than the stored payment.

    Declaration

    Objective-C

    SCPErrorAccountIdMismatchWhileForwarding = 1930

    Swift

    static var accountIdMismatchWhileForwarding: ErrorCode.Code { get }

  • Error reported when calling collectPaymentMethod with an offline PaymentIntent and a CollectConfiguration with updatePaymentIntent set to true.

    Declaration

    Objective-C

    SCPErrorUpdatePaymentIntentUnavailableWhileOffline = 1935

    Swift

    static var updatePaymentIntentUnavailableWhileOffline: ErrorCode.Code { get }

  • Error reported when calling collectPaymentMethod with offline mode enabled and a CollectConfiguration with updatePaymentIntent set to true.

    Declaration

    Objective-C

    SCPErrorUpdatePaymentIntentUnavailableWhileOfflineModeEnabled = 1936

    Swift

    static var updatePaymentIntentUnavailableWhileOfflineModeEnabled: ErrorCode.Code { get }

  • Error reported when a test payment attempted to forward while operating in livemode. The testmode transaction will be deleted.

    Declaration

    Objective-C

    SCPErrorForwardingTestModePaymentInLiveMode = 1937

    Swift

    static var forwardingTestModePaymentInLiveMode: ErrorCode.Code { get }

  • Error reported when a live payment attempted to forward while operating in testmode. Reconnect to this account with livemode keys to resume forwarding livemode transactions.

    Declaration

    Objective-C

    SCPErrorForwardingLiveModePaymentInTestMode = 1938

    Swift

    static var forwardingLiveModePaymentInTestMode: ErrorCode.Code { get }

  • An invalid ConnectionConfiguration was passed through connect.

    Declaration

    Objective-C

    SCPErrorReaderConnectionConfigurationInvalid = 1940

    Swift

    static var readerConnectionConfigurationInvalid: ErrorCode.Code { get }

  • Error reported when calling collectPaymentMethod with request dynamic currency conversion and a CollectConfiguration with updatePaymentIntent set to false.

    Declaration

    Objective-C

    SCPErrorRequestDynamicCurrencyConversionRequiresUpdatePaymentIntent = 1941

    Swift

    static var requestDynamicCurrencyConversionRequiresUpdatePaymentIntent: ErrorCode.Code { get }

  • Dynamic Currency Conversion is not currently available.

    Declaration

    Objective-C

    SCPErrorDynamicCurrencyConversionNotAvailable = 1942

    Swift

    static var dynamicCurrencyConversionNotAvailable: ErrorCode.Code { get }

  • Surcharging is not currently available.

    Declaration

    Objective-C

    SCPErrorSurchargingNotAvailable = 1943

    Swift

    static var surchargingNotAvailable: ErrorCode.Code { get }

  • Surcharge Consent requires amountSurcharge to be set.

    Declaration

    Objective-C

    SCPErrorSurchargeConsentRequiresAmountSurcharge = 1944

    Swift

    static var surchargeConsentRequiresAmountSurcharge: ErrorCode.Code { get }

  • Surcharge Consent Notice requires amountSurcharge and collectConsent to be set.

    Declaration

    Objective-C

    SCPErrorSurchargeConsentNoticeRequiresAmountSurchargeAndCollectConsent = 1945

    Swift

    static var surchargeConsentNoticeRequiresAmountSurchargeAndCollectConsent: ErrorCode.Code { get }

  • Surcharge consent requires a supported reader type

    Declaration

    Objective-C

    SCPErrorSurchargeConsentRequestedForUnsupportedReader = 1946

    Swift

    static var surchargeConsentRequestedForUnsupportedReader: ErrorCode.Code { get }

  • Surcharge consent was declined by the cardholder.

    Declaration

    Objective-C

    SCPErrorSurchargeConsentDeclined = 1947

    Swift

    static var surchargeConsentDeclined: ErrorCode.Code { get }

  • Surcharge consent timed out.

    Declaration

    Objective-C

    SCPErrorSurchargeConsentTimeout = 1948

    Swift

    static var surchargeConsentTimeout: ErrorCode.Code { get }

  • An invalid usage of eligibleAmount or skipTipping was passed into collect.

    Declaration

    Objective-C

    SCPErrorReaderTippingParameterInvalid = 1950

    Swift

    static var readerTippingParameterInvalid: ErrorCode.Code { get }

  • surchargeNotice was specified with a CollectConfiguration with updatePaymentIntent set to false.

    Declaration

    Objective-C

    SCPErrorSurchargeNoticeRequiresUpdatePaymentIntent = 1951

    Swift

    static var surchargeNoticeRequiresUpdatePaymentIntent: ErrorCode.Code { get }

  • Surcharging was attempted while also using dynamic currency conversion.

    Declaration

    Objective-C

    SCPErrorSurchargeUnavailableWithDynamicCurrencyConversion = 1952

    Swift

    static var surchargeUnavailableWithDynamicCurrencyConversion: ErrorCode.Code { get }

  • The provided location ID parameter was invalid.

    Declaration

    Objective-C

    SCPErrorInvalidLocationIdParameter = 1960

    Swift

    static var invalidLocationIdParameter: ErrorCode.Code { get }

  • The operation was cancelled due to an integration error.

    Declaration

    Objective-C

    SCPErrorCanceledDueToIntegrationError = 1961

    Swift

    static var canceledDueToIntegrationError: ErrorCode.Code { get }

  • An invalid parameter was used to start a collect inputs operation.

    Declaration

    Objective-C

    SCPErrorCollectInputsInvalidParameter = 1997

    Swift

    static var collectInputsInvalidParameter: ErrorCode.Code { get }

  • Error reported when the connected account does not have access to this feature, or the reader/SDK version is not compatible with the collect inputs operation.

    Declaration

    Objective-C

    SCPErrorCollectInputsUnsupported = 1998

    Swift

    static var collectInputsUnsupported: ErrorCode.Code { get }

  • The command was canceled by your app.

    Declaration

    Objective-C

    SCPErrorCanceled = 2020

    Swift

    static var canceled: ErrorCode.Code { get }

  • Access to location services is currently disabled. This may be because:

    • The user disabled location services in the system settings.
    • The user denied access to location services for your app.
    • The user’s device is in Airplane Mode and unable to gather location data.

    Declaration

    Objective-C

    SCPErrorLocationServicesDisabled = 2200

    Swift

    static var locationServicesDisabled: ErrorCode.Code { get }

  • This error indicates that Bluetooth is turned off, and the user should use Settings to turn Bluetooth on.

    If Bluetooth is on but the app does not have permission to use it, a different error (SCPErrorBluetoothError) occurs.

    Declaration

    Objective-C

    SCPErrorBluetoothDisabled = 2320

    Swift

    static var bluetoothDisabled: ErrorCode.Code { get }

  • Bluetooth is turned on on the device, but access to Bluetooth has been denied for your app. The user needs to go to Settings > Your App > and enable Bluetooth

    Declaration

    Objective-C

    SCPErrorBluetoothAccessDenied = 2321

    Swift

    static var bluetoothAccessDenied: ErrorCode.Code { get }

  • Scanning for bluetooth devices timed out.

    See

    SCPDiscoveryConfiguration.timeout

    Declaration

    Objective-C

    SCPErrorBluetoothScanTimedOut = 2330

    Swift

    static var bluetoothScanTimedOut: ErrorCode.Code { get }

  • Bluetooth Low Energy is unsupported on this iOS device. Use a different iOS device that supports BLE (also known as Bluetooth 4.0)

    Declaration

    Objective-C

    SCPErrorBluetoothLowEnergyUnsupported = 2340

    Swift

    static var bluetoothLowEnergyUnsupported: ErrorCode.Code { get }

  • Updating the reader software failed because the reader’s battery is too low. Charge the reader before trying again.

    Declaration

    Objective-C

    SCPErrorReaderSoftwareUpdateFailedBatteryLow = 2650

    Swift

    static var readerSoftwareUpdateFailedBatteryLow: ErrorCode.Code { get }

  • Updating the reader software failed because the update was interrupted.

    Declaration

    Objective-C

    SCPErrorReaderSoftwareUpdateFailedInterrupted = 2660

    Swift

    static var readerSoftwareUpdateFailedInterrupted: ErrorCode.Code { get }

  • Updating the reader software failed because the update has expired. Please disconnect and reconnect from the reader to retrieve a new update.

    Declaration

    Objective-C

    SCPErrorReaderSoftwareUpdateFailedExpiredUpdate = 2670

    Swift

    static var readerSoftwareUpdateFailedExpiredUpdate: ErrorCode.Code { get }

  • The reader has a critically low battery and cannot connect to the iOS device. Charge the reader before trying again.

    Declaration

    Objective-C

    SCPErrorBluetoothConnectionFailedBatteryCriticallyLow = 2680

    Swift

    static var bluetoothConnectionFailedBatteryCriticallyLow: ErrorCode.Code { get }

  • The card is not a chip card.

    Declaration

    Objective-C

    SCPErrorCardInsertNotRead = 2810

    Swift

    static var cardInsertNotRead: ErrorCode.Code { get }

  • The swipe could not be read.

    Declaration

    Objective-C

    SCPErrorCardSwipeNotRead = 2820

    Swift

    static var cardSwipeNotRead: ErrorCode.Code { get }

  • Reading a card timed out.

    Declaration

    Objective-C

    SCPErrorCardReadTimedOut = 2830

    Swift

    static var cardReadTimedOut: ErrorCode.Code { get }

  • The card was removed during the transaction.

    Declaration

    Objective-C

    SCPErrorCardRemoved = 2840

    Swift

    static var cardRemoved: ErrorCode.Code { get }

  • A card can only be used for one transaction, and must be removed after being read. Otherwise, subsequent collectPaymentMethod attempts will fail with this error.

    Your terminal delegate will receive -[SCPTerminalDelegate terminal:didReportReaderEvent:info:] with SCPReaderEventCardRemoved when the card is removed.

    The Chipper 2x and WisePad 3 will beep until the card is removed.

    Declaration

    Objective-C

    SCPErrorCardLeftInReader = 2850

    Swift

    static var cardLeftInReader: ErrorCode.Code { get }

  • Error reported when the offline payments database has too many records.

    The offline device should be brought back online to sync payments before collecting more.

    Declaration

    Objective-C

    SCPErrorOfflinePaymentsDatabaseTooLarge = 2860

    Swift

    static var offlinePaymentsDatabaseTooLarge: ErrorCode.Code { get }

  • Connecting to the reader failed because the most recently connected account hasn’t connected to a reader of this type while online. To connect to a reader offline, the SDK must have connected to a reader of the same type and location within the past 30 days.

    Declaration

    Objective-C

    SCPErrorReaderConnectionNotAvailableOffline = 2870

    Swift

    static var readerConnectionNotAvailableOffline: ErrorCode.Code { get }

  • Connecting to the reader failed because the reader was most recently connected to a different location while online.

    Declaration

    Objective-C

    SCPErrorReaderConnectionOfflineLocationMismatch = 2871

    Swift

    static var readerConnectionOfflineLocationMismatch: ErrorCode.Code { get }

  • The device software version running on this reader is out of date. You must connect to this reader while online to install required updates before this reader can be used for offline payments.

    Declaration

    Objective-C

    SCPErrorReaderConnectionOfflineNeedsUpdate = 2872

    Swift

    static var readerConnectionOfflineNeedsUpdate: ErrorCode.Code { get }

  • Connecting to unseen readers offline is disabled. You must connect to this reader at this location while online before it can be used for offline payments.

    Declaration

    Objective-C

    SCPErrorReaderConnectionOfflinePairingUnseenDisabled = 2873

    Swift

    static var readerConnectionOfflinePairingUnseenDisabled: ErrorCode.Code { get }

  • The SDK has not activated a reader online yet, meaning there is no account with which the SDK can associate offline operations.

    Declaration

    Objective-C

    SCPErrorNoLastSeenAccount = 2880

    Swift

    static var noLastSeenAccount: ErrorCode.Code { get }

  • Error reported when the PaymentIntent’s amount exceeds the configured allowable maximum amount for offline transactions.

    Declaration

    Objective-C

    SCPErrorAmountExceedsMaxOfflineAmount = 2890

    Swift

    static var amountExceedsMaxOfflineAmount: ErrorCode.Code { get }

  • Error reported when the PaymentIntent’s currency is not configured as a valid currency for offline transactions.

    Declaration

    Objective-C

    SCPErrorInvalidOfflineCurrency = 2891

    Swift

    static var invalidOfflineCurrency: ErrorCode.Code { get }

  • The reader failed to read the data from the presented payment method. If you encounter this error repeatedly, the reader may be faulty.

    Declaration

    Objective-C

    SCPErrorMissingEMVData = 2892

    Swift

    static var missingEMVData: ErrorCode.Code { get }

  • The command was not permitted to execute by the operating system. This can happen for a number of reasons, but most commonly:

    • Your application does not have the necessary entitlements.
    • Your application bundle is invalid.

    Declaration

    Objective-C

    SCPErrorCommandNotAllowed = 2900

    Swift

    static var commandNotAllowed: ErrorCode.Code { get }

  • The mobile device on which the app is running is in an unsupported configuration. Verify that the device is running a supported version of iOS and that the mobile device has the capability you are attempting to use.

    Declaration

    Objective-C

    SCPErrorUnsupportedMobileDeviceConfiguration = 2910

    Swift

    static var unsupportedMobileDeviceConfiguration: ErrorCode.Code { get }

  • The mobile device on which the app is running must have a passcode set.

    Declaration

    Objective-C

    SCPErrorPasscodeNotEnabled = 2920

    Swift

    static var passcodeNotEnabled: ErrorCode.Code { get }

  • The card reader cannot be used while a phone call is active.

    Declaration

    Objective-C

    SCPErrorCommandNotAllowedDuringCall = 2930

    Swift

    static var commandNotAllowedDuringCall: ErrorCode.Code { get }

  • An attempt was made to charge an amount not supported by the reader.

    Declaration

    Objective-C

    SCPErrorInvalidAmount = 2940

    Swift

    static var invalidAmount: ErrorCode.Code { get }

  • An attempt was made to charge an amount in a currency not supported by the reader.

    Declaration

    Objective-C

    SCPErrorInvalidCurrency = 2950

    Swift

    static var invalidCurrency: ErrorCode.Code { get }

  • Failed to accept reader-specific terms of service because there is no iCloud user signed in. Direct the user to sign into an appropriate iCloud account via iOS Settings and try again.

    Declaration

    Objective-C

    SCPErrorTapToPayReaderTOSAcceptanceRequiresiCloudSignIn = 2960

    Swift

    static var tapToPayReaderTOSAcceptanceRequiresiCloudSignIn: ErrorCode.Code { get }

  • The user cancelled reader-specific terms of service acceptance.

    Declaration

    Objective-C

    SCPErrorTapToPayReaderTOSAcceptanceCanceled = 2970

    Swift

    static var tapToPayReaderTOSAcceptanceCanceled: ErrorCode.Code { get }

  • A timeout occurred while processing a collect inputs operation.

    Declaration

    Objective-C

    SCPErrorCollectInputsTimedOut = 2971

    Swift

    static var collectInputsTimedOut: ErrorCode.Code { get }

  • Scanning for USB devices timed out.

    See

    SCPUsbDiscoveryConfiguration.timeout

    Declaration

    Objective-C

    SCPErrorUsbDiscoveryTimedOut = 2972

    Swift

    static var usbDiscoveryTimedOut: ErrorCode.Code { get }

  • Offline payments unavailable while the iOS device is locked. Unlock to restore functionality.

    Declaration

    Objective-C

    SCPErrorOfflineEncryptionKeysUnavailable = 2973

    Swift

    static var offlineEncryptionKeysUnavailable: ErrorCode.Code { get }

  • The reader is busy.

    Declaration

    Objective-C

    SCPErrorReaderBusy = 3010

    Swift

    static var readerBusy: ErrorCode.Code { get }

  • An incompatible reader was detected. You can only use the Stripe Terminal iOS SDK with one of Stripe’s pre-certified readers.

    See

    https://stripe.com/docs/terminal/readers

    Declaration

    Objective-C

    SCPErrorIncompatibleReader = 3030

    Swift

    static var incompatibleReader: ErrorCode.Code { get }

  • Could not communicate with the reader.

    Declaration

    Objective-C

    SCPErrorReaderCommunicationError = 3060

    Swift

    static var readerCommunicationError: ErrorCode.Code { get }

  • NFC functionality is disabled. Among other things, it may indicate that the app does not have permission to use NFC.

    Declaration

    Objective-C

    SCPErrorNFCDisabled = 3100

    Swift

    static var nfcDisabled: ErrorCode.Code { get }

  • Generic Bluetooth error.

    Among other things, it may indicate that the app does not have permission to use Bluetooth (iOS 13+).

    Declaration

    Objective-C

    SCPErrorBluetoothError = 3200

    Swift

    static var bluetoothError: ErrorCode.Code { get }

  • Connecting to the bluetooth device timed out. Make sure the device is powered on, in range, and not connected to another app or device. If this error continues to occur, you may need to charge the device.

    Declaration

    Objective-C

    SCPErrorBluetoothConnectTimedOut = 3210

    Swift

    static var bluetoothConnectTimedOut: ErrorCode.Code { get }

  • The Bluetooth device was disconnected unexpectedly.

    Declaration

    Objective-C

    SCPErrorBluetoothDisconnected = 3230

    Swift

    static var bluetoothDisconnected: ErrorCode.Code { get }

  • Bluetooth pairing error, the reader has removed this device pairing information. Forget the reader in iOS Settings.

    Declaration

    Objective-C

    SCPErrorBluetoothPeerRemovedPairingInformation = 3240

    Swift

    static var bluetoothPeerRemovedPairingInformation: ErrorCode.Code { get }

  • The Bluetooth reader is already paired to another device. The Bluetooth reader must have its pairing reset to connect to this device.

    Declaration

    Objective-C

    SCPErrorBluetoothAlreadyPairedWithAnotherDevice = 3241

    Swift

    static var bluetoothAlreadyPairedWithAnotherDevice: ErrorCode.Code { get }

  • Generic reader software update error.

    Declaration

    Objective-C

    SCPErrorReaderSoftwareUpdateFailed = 3800

    Swift

    static var readerSoftwareUpdateFailed: ErrorCode.Code { get }

  • Updating the reader software failed because there was an error communicating with the reader.

    Declaration

    Objective-C

    SCPErrorReaderSoftwareUpdateFailedReaderError = 3830

    Swift

    static var readerSoftwareUpdateFailedReaderError: ErrorCode.Code { get }

  • Updating the reader software failed because there was an error communicating with the update server.

    Declaration

    Objective-C

    SCPErrorReaderSoftwareUpdateFailedServerError = 3840

    Swift

    static var readerSoftwareUpdateFailedServerError: ErrorCode.Code { get }

  • confirmPaymentIntent was called from a reader with an unsupported reader version. You will need to update your reader to the most recent version in order to accept payments. We suggest you prompt your user to disconnect and reconnect their reader in order to update the reader.

    See

    https://stripe.com/docs/terminal/readers/bbpos-chipper2xbt#updating-reader-software

    See

    https://stripe.com/docs/terminal/readers/bbpos-wisepad3#updating-reader-software

    Declaration

    Objective-C

    SCPErrorUnsupportedReaderVersion = 3850

    Swift

    static var unsupportedReaderVersion: ErrorCode.Code { get }

  • The reader returned from discovery does not have an IP address and cannot be connected to. The IP address should have been set by the SDK during registration of the reader. Try registering the reader again.

    See

    https://stripe.com/docs/terminal/readers/connecting/verifone-p400#register-reader

    Declaration

    Objective-C

    SCPErrorUnknownReaderIpAddress = 3860

    Swift

    static var unknownReaderIpAddress: ErrorCode.Code { get }

  • Connecting to reader over the internet timed out. Make sure your device and reader are on the same Wifi network and your reader is connected to the Wifi network.

    See

    https://stripe.com/docs/terminal/readers/verifone-p400#troubleshooting

    Declaration

    Objective-C

    SCPErrorInternetConnectTimeOut = 3870

    Swift

    static var internetConnectTimeOut: ErrorCode.Code { get }

  • Connecting to the reader failed because it is currently in use and SCPConnectionConfiguration.failIfInUse was set to true.

    Try to connect again with failIfInUse = false, or choose a different reader.

    A reader is in use while it’s collecting a payment.

    See

    https://stripe.com/docs/terminal/readers/connecting/verifone-p400#connect-reader-ios

    Declaration

    Objective-C

    SCPErrorConnectFailedReaderIsInUse = 3880

    Swift

    static var connectFailedReaderIsInUse: ErrorCode.Code { get }

  • The Bluetooth reader has disconnected and we are attempting to reconnect.

    Declaration

    Objective-C

    SCPErrorBluetoothReconnectStarted = 3890

    Swift

    static var bluetoothReconnectStarted: ErrorCode.Code { get }

  • An attempt was made to interact with the reader while the the app is in the background.

    Declaration

    Objective-C

    SCPErrorReaderNotAccessibleInBackground = 3900

    Swift

    static var readerNotAccessibleInBackground: ErrorCode.Code { get }

  • The app went to background before a reader request completed.

    Declaration

    Objective-C

    SCPErrorTapToPayReaderRequestInterrupted = 3905

    Swift

    static var tapToPayReaderRequestInterrupted: ErrorCode.Code { get }

  • Preparing the Tap To Pay reader to collect payments failed. Try connecting again.

    Declaration

    Objective-C

    SCPErrorTapToPayReaderFailedToPrepare = 3910

    Swift

    static var tapToPayReaderFailedToPrepare: ErrorCode.Code { get }

  • This device cannot be used to process using the Tap To Pay reader as it has been banned.

    Declaration

    Objective-C

    SCPErrorTapToPayReaderDeviceBanned = 3920

    Swift

    static var tapToPayReaderDeviceBanned: ErrorCode.Code { get }

  • The operation could not be completed because the reader-specific terms of service have not yet been accepted. Try connecting again.

    Declaration

    Objective-C

    SCPErrorTapToPayReaderTOSNotYetAccepted = 3930

    Swift

    static var tapToPayReaderTOSNotYetAccepted: ErrorCode.Code { get }

  • Failed to accept reader-specific terms of service using the signed-in Apple ID. Ensure the Apple ID is still active and in a good standing and try again.

    Declaration

    Objective-C

    SCPErrorTapToPayReaderTOSAcceptanceFailed = 3940

    Swift

    static var tapToPayReaderTOSAcceptanceFailed: ErrorCode.Code { get }

  • This merchant account cannot be used with Tap To Pay reader as it has been blocked.

    Declaration

    Objective-C

    SCPErrorTapToPayReaderMerchantBlocked = 3950

    Swift

    static var tapToPayReaderMerchantBlocked: ErrorCode.Code { get }

  • This merchant account cannot be used with the Tap To Pay reader as it is invalid.

    Declaration

    Objective-C

    SCPErrorTapToPayReaderInvalidMerchant = 3960

    Swift

    static var tapToPayReaderInvalidMerchant: ErrorCode.Code { get }

  • An error that indicates the linked Apple ID account has been deactivated by the merchant.

    Declaration

    Objective-C

    SCPErrorTapToPayReaderAccountDeactivated = 3970

    Swift

    static var tapToPayReaderAccountDeactivated: ErrorCode.Code { get }

  • The reader is missing encryption keys required for taking payments and has disconnected and rebooted. Reconnect to the reader to attempt to re-install the keys. If the error persists, contact support.

    Declaration

    Objective-C

    SCPErrorReaderMissingEncryptionKeys = 3980

    Swift

    static var readerMissingEncryptionKeys: ErrorCode.Code { get }

  • The USB device was disconnected unexpectedly.

    Declaration

    Objective-C

    SCPErrorUsbDisconnected = 3990

    Swift

    static var usbDisconnected: ErrorCode.Code { get }

  • The printer is currently busy.

    Declaration

    Objective-C

    SCPErrorPrinterBusy = 4000

    Swift

    static var printerBusy: ErrorCode.Code { get }

  • The printer has a paper jam.

    Declaration

    Objective-C

    SCPErrorPrinterPaperJam = 4001

    Swift

    static var printerPaperJam: ErrorCode.Code { get }

  • The printer is out of paper.

    Declaration

    Objective-C

    SCPErrorPrinterOutOfPaper = 4002

    Swift

    static var printerOutOfPaper: ErrorCode.Code { get }

  • The printer’s cover or head assembly is open.

    Declaration

    Objective-C

    SCPErrorPrinterCoverOpen = 4003

    Swift

    static var printerCoverOpen: ErrorCode.Code { get }

  • The reader does not have a printer.

    Declaration

    Objective-C

    SCPErrorPrinterAbsent = 4004

    Swift

    static var printerAbsent: ErrorCode.Code { get }

  • The reader has a printer but it is currently unavailable.

    Declaration

    Objective-C

    SCPErrorPrinterUnavailable = 4005

    Swift

    static var printerUnavailable: ErrorCode.Code { get }

  • Generic printer error. See error message for more details.

    Declaration

    Objective-C

    SCPErrorPrinterError = 4006

    Swift

    static var printerError: ErrorCode.Code { get }

  • The reader cannot be connected to because it is already connected to a different device.

    Declaration

    Objective-C

    SCPErrorReaderConnectedToAnotherDevice = 4020

    Swift

    static var readerConnectedToAnotherDevice: ErrorCode.Code { get }

  • The reader has been tampered.

    Declaration

    Objective-C

    SCPErrorReaderTampered = 4100

    Swift

    static var readerTampered: ErrorCode.Code { get }

  • Unexpected SDK error.

    Declaration

    Objective-C

    SCPErrorUnexpectedSdkError = 5000

    Swift

    static var unexpectedSdkError: ErrorCode.Code { get }

  • Unexpected reader error.

    Declaration

    Objective-C

    SCPErrorUnexpectedReaderError = 5001

    Swift

    static var unexpectedReaderError: ErrorCode.Code { get }

  • Encryption key failed to initialize. Offline payments not available.

    The encryption key needed to decrypt the payment records is not available. This can happen if an iOS backup that included offline payment records was restored on a new device. Those records must be forwarded from the original device and the records must be deleted from this device.

    Please contact support at https://support.stripe.com/ for more help.

    Declaration

    Objective-C

    SCPErrorEncryptionKeyFailure = 5002

    Swift

    static var encryptionKeyFailure: ErrorCode.Code { get }

  • Encryption key still initializing. Offline payments are not yet available, please try again.

    Declaration

    Objective-C

    SCPErrorEncryptionKeyStillInitializing = 5003

    Swift

    static var encryptionKeyStillInitializing: ErrorCode.Code { get }

  • An unexpected error occurred while processing a collectInputs operation.

    Declaration

    Objective-C

    SCPErrorCollectInputsApplicationError = 5004

    Swift

    static var collectInputsApplicationError: ErrorCode.Code { get }

  • A generic reader error is returned when a reader returns an error code that is not yet known to this version of the Terminal SDK. Please update to the newest SDK version to receive a specific error; or consult user info keys SCPErrorKeyReaderMessage and SCPErrorKeyStripeAPIErrorCode to get more details using your current SDK.

    Declaration

    Objective-C

    SCPErrorGenericReaderError = 5005

    Swift

    static var genericReaderError: ErrorCode.Code { get }

  • An error occurred while processing a collect data operation.

    Declaration

    Objective-C

    SCPErrorCollectDataApplicationError = 5006

    Swift

    static var collectDataApplicationError: ErrorCode.Code { get }

  • An error occurred while processing a display surcharge consent request.

    Declaration

    Objective-C

    SCPErrorDisplaySurchargeConsentApplicationError = 5007

    Swift

    static var displaySurchargeConsentApplicationError: ErrorCode.Code { get }

  • The Terminal operation shouldn’t have been called at this time.

    Declaration

    Objective-C

    SCPErrorUnexpectedOperationError = 5008

    Swift

    static var unexpectedOperationError: ErrorCode.Code { get }

  • The Stripe API declined the transaction. Inspect the error’s requestError property for more information about the decline, including the decline code.

    Declaration

    Objective-C

    SCPErrorDeclinedByStripeAPI = 6000

    Swift

    static var declinedByStripeAPI: ErrorCode.Code { get }

  • The reader declined the transaction. Try another card.

    Declaration

    Objective-C

    SCPErrorDeclinedByReader = 6500

    Swift

    static var declinedByReader: ErrorCode.Code { get }

  • The card is not supported by the current reader’s configuration.

    Declaration

    Objective-C

    SCPErrorCardNotSupported = 6510

    Swift

    static var cardNotSupported: ErrorCode.Code { get }

  • The cardholder must give consent in order for this operation to succeed.

    Declaration

    Objective-C

    SCPErrorCommandRequiresCardholderConsent = 6700

    Swift

    static var commandRequiresCardholderConsent: ErrorCode.Code { get }

  • Customer consent is required to set allow redisplay to ALWAYS or LIMITED for this operation.

    Declaration

    Objective-C

    SCPErrorCommandInvalidAllowRedisplay = 6701

    Swift

    static var commandInvalidAllowRedisplay: ErrorCode.Code { get }

  • The refund failed. The customer’s bank or card issuer was unable to process it correctly (e.g., a closed bank account or a problem with the card)

    Declaration

    Objective-C

    SCPErrorRefundFailed = 6800

    Swift

    static var refundFailed: ErrorCode.Code { get }

  • Error reported when collectPaymentMethod or confirmPaymentIntent was called while offline and the card was read using the swipe method.

    Payment method data collected using the Swipe card read method cannot be processed online.

    Retry the payment by calling collectPaymentMethod() again.

    Declaration

    Objective-C

    SCPErrorCardSwipeNotAvailable = 6900

    Swift

    static var cardSwipeNotAvailable: ErrorCode.Code { get }

  • Error reported when collectPaymentMethod or confirmPaymentIntent was called while offline and the presented card was an Interac card.

    Retry the payment by calling collectPaymentMethod() again.

    Declaration

    Objective-C

    SCPErrorInteracNotSupportedOffline = 6901

    Swift

    static var interacNotSupportedOffline: ErrorCode.Code { get }

  • Confirming a payment while offline and the card was identified as being expired.

    Declaration

    Objective-C

    SCPErrorOfflineAndCardExpired = 6902

    Swift

    static var offlineAndCardExpired: ErrorCode.Code { get }

  • Confirming a payment while offline and the card’s verification failed.

    Retry the payment by calling collectPaymentMethod() again and try a different card if the error persists.

    Declaration

    Objective-C

    SCPErrorOfflineTransactionDeclined = 6903

    Swift

    static var offlineTransactionDeclined: ErrorCode.Code { get }

  • Error reported when collectPaymentMethod was called while online and confirmPaymentIntent was called while offline.

    Retry the payment by calling collectPaymentMethod() again.

    Declaration

    Objective-C

    SCPErrorOfflineCollectAndConfirmMismatch = 6904

    Swift

    static var offlineCollectAndConfirmMismatch: ErrorCode.Code { get }

  • Error reported when confirmPaymentIntent was called while offline and the presented card was authenticated with an online PIN. Retry the payment with another card.

    Declaration

    Objective-C

    SCPErrorOnlinePinNotSupportedOffline = 6905

    Swift

    static var onlinePinNotSupportedOffline: ErrorCode.Code { get }

  • Error reported when the card used is a known test card and the SDK is operating in livemode.

    Declaration

    Objective-C

    SCPErrorOfflineTestCardInLivemode = 6906

    Swift

    static var offlineTestCardInLivemode: ErrorCode.Code { get }

  • The SDK is not connected to the internet.

    Declaration

    Objective-C

    SCPErrorNotConnectedToInternet = 9000

    Swift

    static var notConnectedToInternet: ErrorCode.Code { get }

  • The underlying request timed out.

    Declaration

    Objective-C

    SCPErrorRequestTimedOut = 9010

    Swift

    static var requestTimedOut: ErrorCode.Code { get }

  • The underlying request returned an API error.

    Declaration

    Objective-C

    SCPErrorStripeAPIError = 9020

    Swift

    static var stripeAPIError: ErrorCode.Code { get }

  • The API response from Stripe could not be decoded.

    Declaration

    Objective-C

    SCPErrorStripeAPIResponseDecodingError = 9030

    Swift

    static var stripeAPIResponseDecodingError: ErrorCode.Code { get }

  • Generic network error

    Declaration

    Objective-C

    SCPErrorInternalNetworkError = 9040

    Swift

    static var internalNetworkError: ErrorCode.Code { get }

  • Tap to Pay network error

    Declaration

    Objective-C

    SCPErrorTapToPayInternalNetworkError = 9041

    Swift

    static var tapToPayInternalNetworkError: ErrorCode.Code { get }

  • Your implementation of -[SCPConnectionTokenProvider fetchConnectionToken:] called the completion block with an error.

    Declaration

    Objective-C

    SCPErrorConnectionTokenProviderCompletedWithError = 9050

    Swift

    static var connectionTokenProviderCompletedWithError: ErrorCode.Code { get }

  • Error reported while forwarding offline payments when the connection token provider returns an error.

    Declaration

    Objective-C

    SCPErrorConnectionTokenProviderCompletedWithErrorWhileForwarding = 9051

    Swift

    static var connectionTokenProviderCompletedWithErrorWhileForwarding: ErrorCode.Code { get }

  • Your implementation of -[SCPConnectionTokenProvider fetchConnectionToken:] did not call the provided completion block within 60 seconds.

    Declaration

    Objective-C

    SCPErrorConnectionTokenProviderTimedOut = 9052

    Swift

    static var connectionTokenProviderTimedOut: ErrorCode.Code { get }

  • The current session has expired and the reader must be disconnected and reconnected. The SDK will attempt to auto-disconnect for you and you should instruct your user to reconnect it. -[SCPReaderDelegate reader:didDisconnect:] will be called if the SDK is able to successfully auto-disconnect. If it does not successfully auto-disconnect (didDisconnect: will not be called and SCPTerminal.connectionStatus will still be SCPConnectionStatusConnected) you can attempt again via -[SCPTerminal disconnectReader:] or you can instruct your user to disconnect manually by turning the reader off.

    Note this error will only occur in one of the following calls:

    Declaration

    Objective-C

    SCPErrorSessionExpired = 9060

    Swift

    static var sessionExpired: ErrorCode.Code { get }

  • Error reported when the iOS device is offline and the PaymentIntent was created with offlineBehavior set to requireOnline.

    Declaration

    Objective-C

    SCPErrorNotConnectedToInternetAndOfflineBehaviorRequireOnline = 10106

    Swift

    static var notConnectedToInternetAndOfflineBehaviorRequireOnline: ErrorCode.Code { get }

  • Error reported when a SCPPaymentIntent was created with SCPOfflineBehaviorForceOffline and the reader in use is not configured to operate offline. Use the Terminal Configuration API to enable the functionality or retry with another value for SCPOfflineBehavior.

    Declaration

    Objective-C

    SCPErrorOfflineBehaviorForceOfflineWithFeatureDisabled = 10107

    Swift

    static var offlineBehaviorForceOfflineWithFeatureDisabled: ErrorCode.Code { get }