SCPError

The SDK is busy executing another command. The SDK can only execute a single command at a time. You can use the paymentStatus or connectionStatus properties on your SCPTerminal instance (or the corresponding delegate methods) to determine if the SDK is ready to accept another command.

Canceling a command failed because the command already completed.

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.

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

collectPaymentMethod or processPayment was called with a nil PaymentIntent.

collectSetupIntentPaymentMethod or processSetupIntent was called with a nil SetupIntent.

processRefund was called without calling collectRefundPaymentMethod beforehand.

The RefundParameters object has invalid values. The Charge ID (ch_123abc) can be found on the PaymentIntent object, which you should get from your backend.

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

The SDK must be actively Discovering Readers in order to successfully connect to a reader. See documentation on -[SCPTerminal discoverReaders:delegate:completion:] and -[SCPTerminal connectReader:completion:]

Before connecting to a reader, it must have already been discovered in the current discovery session. Trying to connect to a reader from a previous discovery session is not supported.

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.

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.

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.

An invalid ConnectionConfiguration was passed through connect.

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

The provided location ID parameter was invalid.

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.

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.

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.

processPayment 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 Apple Built-In reader to collect payments failed. Try connecting again.

This device cannot be used to process using the Apple Built-In 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 Apple Built-In reader as it has been blocked.

This merchant account cannot be used with the Apple Built-In reader as it is invalid.

Unexpected SDK error.

Unexpected reader error.

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.

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)

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.

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. -[SCPTerminalDelegate terminal:didReportUnexpectedReaderDisconnect:] will be called if the SDK is able to successfully auto-disconnect. If it does not successfully auto-disconnect (didReportUnexpectedReaderDisconnect 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 a Verifone P400 or a BBPOS WisePOS E
• -[SCPTerminal processPayment:completion:]
• -[SCPTerminal cancelPaymentIntent:completion:]
• -[SCPTerminal readReusableCard:delegate:completion:]
• -[SCPTerminal collectRefundMethod:parameters]
• -[SCPTerminal processRefund:completion]