SCPError

Canceling a command failed because the command already completed.

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

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

Already connected to a reader.

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.

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

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

collectPaymentMethod or confirmPaymentIntent was called with a nil PaymentIntent.

collectSetupIntentPaymentMethod or confirmSetupIntent was called with a nil SetupIntent.

confirmRefund was called without calling collectRefundPaymentMethod beforehand.

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.

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

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.

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

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.

-[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.

This feature is currently not available for the selected reader.

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

The ListLocationsParameters object has invalid values.

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

A required parameter was invalid or missing.

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

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

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

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

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

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.

An invalid ConnectionConfiguration was passed through connect.

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

Dynamic Currency Conversion is not currently available.

Surcharging is not currently available.

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

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

Surcharging was attempted while also using dynamic currency conversion.

The provided location ID parameter was invalid.

The operation was cancelled due to an integration error.

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

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.

The command was canceled by your app.

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.

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.

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

Scanning for bluetooth devices timed out.

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

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

Updating the reader software failed because the update was interrupted.

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

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

The card is not a chip card.

The swipe could not be read.

Reading a card timed out.

The card was removed during the transaction.

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.

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.

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.

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

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.

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.

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

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

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

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

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.

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.

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

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

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

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

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.

The user cancelled reader-specific terms of service acceptance.

A timeout occurred while processing a collect inputs operation.

Scanning for USB devices timed out.

The reader is busy.

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

Could not communicate with the reader.

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

Generic Bluetooth error.

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

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.

The Bluetooth device was disconnected unexpectedly.

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

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

Generic reader software update error.

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

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

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.

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.

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.

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.

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

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

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

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

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

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.

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

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

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

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.

The USB device was disconnected unexpectedly.

Unexpected SDK error.

Unexpected reader error.

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.

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

An unexpected error occurred while processing a collectInputs operation.

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.

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

The reader declined the transaction. Try another card.

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

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

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)

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.

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.

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

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.

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

Retry the payment by calling collectPaymentMethod() again.

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

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

The SDK is not connected to the internet.

The underlying request timed out.

The underlying request returned an API error.

The API response from Stripe could not be decoded.

Generic network error

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

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

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

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:

• -[SCPTerminal createPaymentIntent:completion:]
• -[SCPTerminal retrievePaymentIntent:completion:]
• -[SCPTerminal collectPaymentMethod:delegate:completion:] if connected to an Internet reader
• -[SCPTerminal confirmPaymentIntent:completion:]
• -[SCPTerminal cancelPaymentIntent:completion:]
• -[SCPTerminal collectRefundMethod:parameters] if connected to an Internet reader
• -[SCPTerminal confirmRefund:completion]
• -[SCPTerminal createSetupIntent:completion:]
• -[SCPTerminal collectSetupIntentPaymentMethod:customerConsentCollected:completion:] if connected to an Internet reader
• -[SCPTerminal confirmSetupIntent:completion:]
• -[SCPTerminal cancelSetupIntent:completion:]
• -[SCPTerminal collectInputs:completion:]

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

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.