Only IOS. 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.

bluetoothPermissionDenied → const TerminalExceptionCode

Android: Either android.permission.BLUETOOTH_CONNECT or android.permission.BLUETOOTH_SCAN must be enabled. IOS: 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

confirmInvalidPaymentIntent → const TerminalExceptionCode

StripeTerminal.confirmPaymentIntent was called with an unknown or invalid PaymentIntent. You must confirm a payment after collecting a payment method. Successfully confirmed payments may not be confirmed again.

confirmInvalidSetupIntent → const TerminalExceptionCode

Only Android. Terminal.confirmPaymentIntent was called with an unknown or invalid PaymentIntent. You must confirm a payment after collecting a payment method. Successfully confirmed payments may not be confirmed again.

invalidClientSecret → const TerminalExceptionCode

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

invalidReaderForUpdate → const TerminalExceptionCode

Only IOS. StripeTerminal.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.

unsupportedOperation → const TerminalExceptionCode

Only Android. The Terminal operation that was called isn't supported for this device type

unexpectedOperation → const TerminalExceptionCode

Only Android. The Terminal operation shouldn't have been called at this time.

unsupportedSdk → const TerminalExceptionCode

StripeTerminal.connectBluetoothReader 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.

featureNotAvailableWithConnectedReader → const TerminalExceptionCode

Only IOS. This feature is currently not available for the selected reader.

usbPermissionDenied → const TerminalExceptionCode

Only Android. User denied USB access when requested by the SDK.

usbDiscoveryTimedOut → const TerminalExceptionCode

Only Android. Scanning for USB devices timed out.

invalidParameter → const TerminalExceptionCode

Android:

MISSING_REQUIRED_PARAMETER: A parameter that is required for your Terminal configuration is missing.
COLLECT_INPUTS_INVALID_PARAMETER: Error reported when invalid parameters are used while processing a collect inputs operation. IOS:
InvalidRefundParameters: 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.
InvalidListLocationsLimitParameter: The ListLocationsParameters object has invalid values.
BluetoothConnectionInvalidLocationIdParameter: The locationId parameter to BluetoothConnectionConfiguration is required but a valid one was not provided.
InvalidLocationIdParameter: The provided location ID parameter was invalid.
ReaderConnectionConfigurationInvalid: An invalid ConnectionConfiguration was passed through connect.
invalidRequiredParameterOnBehalfOf: The PaymentIntent uses on_behalf_of but the Connected Account ID was not set in TapToPayConnectionConfiguration
SCPErrorCollectInputsInvalidParameter: An invalid parameter was used to start a collect inputs operation.

requestDynamicCurrencyConversionRequiresUpdatePaymentIntent → const TerminalExceptionCode

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

dynamicCurrencyConversionNotAvailable → const TerminalExceptionCode

Dynamic Currency Conversion is not currently available. IOS(SCPErrorDynamicCurrencyConversionNotAvailable)

invalidRequiredParameter → const TerminalExceptionCode

A required parameter was invalid or missing.

invalidTipParameter → const TerminalExceptionCode

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

tapToPayUnsupportedDevice → const TerminalExceptionCode

Only Android: The Android device the SDK is running on is unsupported by the local mobile library. Reasons for this might include:

Device is missing a NFC reader
Device does not have a hardware keystore

tapToPayUnsupportedOperatingSystemVersion → const TerminalExceptionCode

Only Android. The SDK is running on a version of Android older

tapToPayDeviceTampered → const TerminalExceptionCode

Only Android. The Android device the SDK is running on has been tampered. Some examples of tampering include:

unlocking the bootloader or rooting the device
replacing factory-provisioned hardware in the device (ex. the motherboard)

tapToPayDebugNotSupported → const TerminalExceptionCode

Only Android. The SDK is running in a debuggable application. This is not supported for security and compliance reasons. Please test the Tap to Pay on Android SDK with a simulated version of the reader by setting DiscoveryConfiguration.isSimulated to true.

tapToPayInsecureEnvironment → const TerminalExceptionCode

Only Android. The SDK is running in an insecure environment. Some examples of insecure situations include:

Other application components are running the secure payment process
Camera is opened by another application during payment collection
Developer mode is enabled or screen recording is active during PIN collection

offlineModeUnsupportedOperatingSystemVersion → const TerminalExceptionCode

Only Android. The Android device the SDK is running on does not support offline mode.

canceled → const TerminalExceptionCode

The command was canceled by your app.

locationServicesDisabled → const TerminalExceptionCode

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.

bluetoothScanTimedOut → const TerminalExceptionCode

Scanning for bluetooth devices timed out.

bluetoothLowEnergyUnsupported → const TerminalExceptionCode

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

readerSoftwareUpdateFailedBatteryLow → const TerminalExceptionCode

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

readerSoftwareUpdateFailedInterrupted → const TerminalExceptionCode

Updating the reader software failed because the update was interrupted.

readerSoftwareUpdateFailedExpiredUpdate → const TerminalExceptionCode

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

readerBatteryCriticallyLow → const TerminalExceptionCode

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

cardInsertNotRead → const TerminalExceptionCode

The card is not a chip card.

cardSwipeNotRead → const TerminalExceptionCode

The swipe could not be read.

cardReadTimedOut → const TerminalExceptionCode

Reading a card timed out.

cardRemoved → const TerminalExceptionCode

The card was removed during the transaction

customerConsentRequired → const TerminalExceptionCode

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

cardLeftInReader → const TerminalExceptionCode

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 ReaderDelegate.onReportReaderEvent with ReaderEventCardRemoved when the card is removed. The Chipper 2x and WisePad 3 will beep until the card is removed.

featureNotEnabledOnAccount → const TerminalExceptionCode

Android: The connected account is not enabled to use the specified feature. Retry without the parameter in question or contact Stripe support to enable the feature on this account. IOS: This feature is not currently available.

passcodeNotEnabled → const TerminalExceptionCode

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

commandNotAllowedDuringCall → const TerminalExceptionCode

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

invalidAmount → const TerminalExceptionCode

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

invalidCurrency → const TerminalExceptionCode

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

tapToPayReaderTOSAcceptanceRequiresiCloudSignIn → const TerminalExceptionCode

Only IOS. 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.

tapToPayReaderTOSAcceptanceCanceled → const TerminalExceptionCode

Only IOS. The user cancelled reader-specific terms of service acceptance.

tapToPayReaderFailedToPrepare → const TerminalExceptionCode

Only IOS. Preparing the Apple Built-In reader to collect payments failed. Try connecting again.

tapToPayReaderDeviceBanned → const TerminalExceptionCode

Only IOS. This device cannot be used to process using the Apple Built-In reader as it has been banned.

tapToPayReaderTOSNotYetAccepted → const TerminalExceptionCode

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

tapToPayReaderTOSAcceptanceFailed → const TerminalExceptionCode

Only IOS. 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.

tapToPayReaderMerchantBlocked → const TerminalExceptionCode

Only IOS. This merchant account cannot be used with Apple Built-In reader as it has been blocked.

tapToPayReaderInvalidMerchant → const TerminalExceptionCode

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

tapToPayReaderAccountDeactivated → const TerminalExceptionCode

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

readerMissingEncryptionKeys → const TerminalExceptionCode

Please contact support at https://support.stripe.com/ for more help. Android: The reader is missing encryption keys required for taking payments. Disconnect and reconnect to the reader to attempt to re-install the keys. If the error persists, contact Stripe support.

readerBusy → const TerminalExceptionCode

The reader is busy.

incompatibleReader → const TerminalExceptionCode

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

readerCommunicationError → const TerminalExceptionCode

Could not communicate with the reader.

unknownReaderIpAddress → const TerminalExceptionCode

Only IOS. 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.

internetConnectTimeOut → const TerminalExceptionCode

Only IOS. 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.

connectFailedReaderIsInUse → const TerminalExceptionCode

Only IOS. Connecting to the reader failed because it is currently in use and 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.

readerNotAccessibleInBackground → const TerminalExceptionCode

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

bluetoothError → const TerminalExceptionCode

Generic Bluetooth error.

bluetoothConnectTimedOut → const TerminalExceptionCode

Only IOS. 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.

bluetoothDisconnected → const TerminalExceptionCode

The Bluetooth device was disconnected unexpectedly.

bluetoothPeerRemovedPairingInformation → const TerminalExceptionCode

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

bluetoothAlreadyPairedWithAnotherDevice → const TerminalExceptionCode

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

bluetoothReconnectStarted → const TerminalExceptionCode

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

usbDisconnected → const TerminalExceptionCode

Only Android. The USB device was disconnected unexpectedly.

usbReconnectStarted → const TerminalExceptionCode

Only Android. The USB device was disconnected unexpectedly, reconnecting.

readerConnectedToAnotherDevice → const TerminalExceptionCode

Only Android. The reader cannot be reached because it is already connected to a different device.

readerSoftwareUpdateFailed → const TerminalExceptionCode

Generic reader software update error.

readerSoftwareUpdateFailedReaderError → const TerminalExceptionCode

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

readerSoftwareUpdateFailedServerError → const TerminalExceptionCode

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

nfcDisabled → const TerminalExceptionCode

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

unsupportedReaderVersion → const TerminalExceptionCode

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

unexpectedSdkError → const TerminalExceptionCode

Unexpected SDK error.

unexpectedReaderError → const TerminalExceptionCode

Only IOS. Unexpected reader error.

encryptionKeyFailure → const TerminalExceptionCode

Only IOS. 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.

encryptionKeyStillInitializing → const TerminalExceptionCode

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

declinedByStripeApi → const TerminalExceptionCode

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

declinedByReader → const TerminalExceptionCode

The reader declined the transaction. Try another card.

commandInvalidAllowRedisplay → const TerminalExceptionCode

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

notConnectedToInternet → const TerminalExceptionCode

Only IOS. The SDK is not connected to the internet.

requestTimedOut → const TerminalExceptionCode

The underlying request timed out.

stripeApiConnectionError → const TerminalExceptionCode

Only android. Failure to connect to Stripe's API.

stripeApiError → const TerminalExceptionCode

Only android. The underlying request returned an API error.

stripeApiResponseDecodingError → const TerminalExceptionCode

The API response from Stripe could not be decoded.

internalNetworkError → const TerminalExceptionCode

Only IOS. Generic network error

connectionTokenProviderError → const TerminalExceptionCode

Your implementation of StripeTerminal.getInstance:fetchToken throws an error.

sessionExpired → const TerminalExceptionCode

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. StripeTerminal.onUnexpectedReaderDisconnect will be called if the SDK is able to successfully auto-disconnect. If it does not successfully auto-disconnect (onUnexpectedReaderDisconnect will not be called and StripeTerminal.connectionStatus will still be ConnectionStatusConnected) you can attempt again via StripeTerminal.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: StripeTerminal.createPaymentIntent, StripeTerminal.retrievePaymentIntent, StripeTerminal.confirmPaymentIntent, and StripeTerminal.cancelPaymentIntent.

unsupportedMobileDeviceConfiguration → const TerminalExceptionCode

Android:

ANDROID_API_LEVEL_ERROR: The SDK is running on an unsupported version of Android. This occurs when an integrator overrides minSdkVersion. IOS:
UnsupportedMobileDeviceConfiguration: 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.

commandNotAllowed → const TerminalExceptionCode

Only IOS: 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.

amountExceedsMaxOfflineAmount → const TerminalExceptionCode

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

offlinePaymentsDatabaseTooLarge → const TerminalExceptionCode

Error reported when the offline payments database has too many records. The Terminal should be brought back online to forward payments before collecting more.

readerConnectionNotAvailableOffline → const TerminalExceptionCode

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 90 days.

readerConnectionOfflineLocationMismatch → const TerminalExceptionCode

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

readerConnectionOfflineNeedsUpdate → const TerminalExceptionCode

Only IOS. 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.

locationConnectionNotAvailableOffline → const TerminalExceptionCode

Connecting to the reader at this location failed. To connect a reader at a specified location while offline, a reader must have been connected online at that location within the last several weeks. Android(LOCATION_CONNECTION_NOT_AVAILABLE_OFFLINE) IOS(SCPErrorReaderConnectionOfflinePairingUnseenDisabled)

noLastSeenAccount → const TerminalExceptionCode

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

invalidOfflineCurrency → const TerminalExceptionCode

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

refundFailed → const TerminalExceptionCode

Only IOS. 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)

cardSwipeNotAvailable → const TerminalExceptionCode

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.

interacNotSupportedOffline → const TerminalExceptionCode

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.

onlinePinNotSupportedOffline → const TerminalExceptionCode

Only Android. Error reported when confirmPaymentIntent was called while offline and the presented card was authenticated with an online PIN. Retry the payment by calling collectPaymentMethod() again.

mobileWalletNotSupportedOnSetupIntents → const TerminalExceptionCode

offlineAndCardExpired → const TerminalExceptionCode

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

offlineTransactionDeclined → const TerminalExceptionCode

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.

offlineCollectAndConfirmMismatch → const TerminalExceptionCode

Error reported when collectPaymentMethod was called while online and confirmPaymentIntent was called while offline. Retry the payment by calling collectPaymentMethod() again.

forwardingTestModePaymentInLiveMode → const TerminalExceptionCode

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

forwardingLiveModePaymentInTestMode → const TerminalExceptionCode

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.

offlinePaymentIntentNotFound → const TerminalExceptionCode

Only Android. Error reported when processing a PaymentIntent that doesn't have a corresponding create request. In this situation, the PaymentIntent should be created again. This would typically happen if:

The PaymentIntent was created offline.
The SDK re-established connection to Stripe's backend and successfully forwarded the PaymentIntent.
Your application attempted to process the PaymentIntent, but it was already forwarded.

updatePaymentIntentUnavailableWhileOffline → const TerminalExceptionCode

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

updatePaymentIntentUnavailableWhileOfflineModeEnabled → const TerminalExceptionCode

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

missingEmvData → const TerminalExceptionCode

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

connectionTokenProviderErrorWhileForwarding → const TerminalExceptionCode

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

connectionTokenProviderTimedOut → const TerminalExceptionCode

Only IOS. Your implementation of StripeTerminal.getInstance:fetchToken did not call the provided completion block within 60 seconds.

accountIdMismatchWhileForwarding → const TerminalExceptionCode

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

offlineBehaviorForceOfflineWithFeatureDisabled → const TerminalExceptionCode

Error reported when a PaymentIntent was created with OfflineBehaviorForceOffline 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 OfflineBehavior.

notConnectedToInternetAndOfflineBehaviorRequireOnline → const TerminalExceptionCode

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

testCardInLiveMode → const TerminalExceptionCode

The card used is a known test card and the SDK is operating in livemode.

collectInputsApplicationError → const TerminalExceptionCode

An unexpected error occurred when using collectInputs

collectInputsTimedOut → const TerminalExceptionCode

Error reported when a timeout occurs while processing a collect inputs operation.

canceledDueToIntegrationError → const TerminalExceptionCode

The operation was cancelled due to an integration error.

collectInputsUnsupported → const TerminalExceptionCode

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.

readerSettingsError → const TerminalExceptionCode

Only Android. Error reported when an attempt to get or set reader settings has failed.

invalidSurchargeParameter → const TerminalExceptionCode

Only Android. A surcharging parameter is misconfigured or invalid.

readerCommunicationSslError → const TerminalExceptionCode

Only Android. Could not communicate to the reader due to SSL handshake failures. Typically occurs when your device is missing SSL certificates, check that you have the required SSL certificates installed on your device. If the error persists, contact Stripe support.

allowRedisplayInvalid → const TerminalExceptionCode

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

surchargingNotAvailable → const TerminalExceptionCode

Only Ios. Surcharging is not currently available.

surchargeNoticeRequiresUpdatePaymentIntent → const TerminalExceptionCode

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

surchargeUnavailableWithDynamicCurrencyConversion → const TerminalExceptionCode

Only Ios. Surcharging was attempted while also using dynamic currency conversion.

Properties

hashCode → int: The hash code for this object.
no setterinherited
index → int: A numeric identifier for the enumerated value.
no setterinherited
message → String?: final
name → String: Available on Enum, provided by the EnumName extension
The name of the enum value.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Constants

values → const List<TerminalExceptionCode>: A constant List of the values in this enum, in order of their declaration.

TerminalExceptionCode enum

Values

Properties

Methods

Operators

Constants

mek_stripe_terminal library