mek_stripe_terminal library
Classes
- Address
- AmountDetails
- Contains details about items included in the PaymentIntent amount
- BluetoothConnectionConfiguration
- BluetoothDiscoveryConfiguration
- In IOS this class is called BluetoothScanDiscoveryConfiguration
- BluetoothProximityDiscoveryConfiguration
- ONLY ON IOS
-
CancelableFuture<
T> - CardDetails
- CardNetworks
- CardPresentDetails
- CardPresentParameters
- Parameters that will be applied to the card present PaymentIntent.
- Cart
-
An Cart object contains information about what line items are included in the current transaction.
A cart object should be created and then passed into
StripeTerminal.setReaderDisplay, which will display the cart’s contents on the reader’s screen. - CartLineItem
- Represents a single line item in an Cart, displayed on the reader’s screen during checkout.
- Charge
- An object representing a Stripe charge.
- ConnectionConfiguration
- DiscoveryConfiguration
- Protocol for classes to conform to that apply configuration options for discovering readers.
- HandoffConnectionConfiguration
- HandoffDiscoveryConfiguration
- ONLY ON ANDROID
- HandoffReaderDelegate
- The HandoffReaderDelegate class is a listener that should exist for the entire duration of your connection to a reader. It will receive events related to the status of the reader.
- InternetConnectionConfiguration
- InternetDiscoveryConfiguration
- The Internet discovery method searches for internet-connected readers, such as the Stripe S700 or the BBPOS WisePOS E.
- InternetReaderDelegate
- The InternetReaderDelegate class is a listener that should exist for the entire duration of your connection to an internet reader. It will receive events related to the status of the reader.
- Location
- MobileReaderDelegate
- The MobileReaderDelegate class is a listener that should exist for the entire duration of your connection to a reader. It will receive events related to the status of the reader, as well as opportunities to update the reader's software.
- PaymentIntent
- A PaymentIntent tracks the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
- PaymentIntentParameters
- PaymentMethod
- PaymentMethod objects represent your customer’s payment instruments. They can be used with PaymentIntents to collect payments, or saved to Customer objects to store instrument details for future payments.
- PaymentMethodDetails
- PaymentMethodOptionsParameters
- The PaymentMethodOptionsParameters contains options for PaymentMethod creation.
- Reader
- Information about a card reader that has been discovered by or connected to the SDK.
- ReaderDelegateAbstract
- ReaderSoftwareUpdate
- ReceiptDetails
- Refund
- SetupAttempt
- A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation was successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.
- SetupAttemptCardPresentDetails
- An object representing details from a transaction using a cardPresent payment method.
- SetupAttemptPaymentMethodDetails
- Details about a PaymentMethod at a specific time. ex: at time of transaction for a SetupAttempt.
- SetupIntent
- A SetupIntent guides you through the process of setting up and saving a customer’s payment credentials for future payments. For example, you could use a SetupIntent to set up and save your customer’s card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.
- SimulatedCard
- Simulated Card objects can be used with the shared SimulatorConfiguration to simulate different card brand and error cases with a simulated Reader.
- SimulatorConfiguration
- Simulator specific configurations you can set to test your integration’s behavior in different scenarios. We recommend changing these properties during testing to ensure your app works as expected for different reader updates and for different presented cards.
- TapToPayConnectionConfiguration
- TapToPayDiscoveryConfiguration
- The Local Mobile discovery method searches for any readers built into the merchant device that are supported by Stripe Terminal. When discovering a reader with this method didUpdateDiscoveredReaders will only be called once with a list of discovered readers, if any. An error may be provided if a discovery attempt is made in an on a device without hardware support for the Apple Built-In reader or one running an unsupported version of iOS.
- TapToPayReaderDelegate
- The TapToPayReaderDelegate class is a listener that should exist for the entire duration of your connection to a tap-to-pay reader. It will receive events related to the status of the reader.
- Terminal
- Parts documented with "???" are not yet validated
- Tip
- Contains details about tips
- TippingConfiguration
- The TippingConfiguration contains configuration information relevant to collecting tips.
- UsbConnectionConfiguration
- UsbDiscoveryConfiguration
- ONLY ON ANDROID
Enums
- AllowRedisplay
- BatteryStatus
- A categorization of a reader’s battery charge level.
- CaptureMethod
- Controls when the funds will be captured from the customer’s account.
- CardBrand
- CardFundingType
- CardPresentCaptureMethod
- Capture Method values that can be used as card-present payment method options.
- CardPresentRouting
- Transaction routing priorities
- ChargeStatus
- The possible statuses for a charge
- ConfirmationMethod
- ConnectionStatus
- The possible reader connection statuses for the SDK.
- DeviceType
- The reader’s device type.
- DisconnectReason
- Possible reasons for Bluetooth reader disconnects.
- IncrementalAuthorizationStatus
- LocationStatus
- Represents the possible states of the location object for a discovered reader.
- PaymentIntentStatus
- The possible statuses for a PaymentIntent.
- PaymentIntentUsage
- PaymentMethodType
- An enum representing the type of payment method being handled.
- PaymentStatus
- ReaderDisplayMessage
- The display messages that a reader may request be displayed by your app. Used by MobileReaderDelegate.onRequestReaderDisplayMessage.
- ReaderEvent
- ReaderInputOption
- This OptionSet represents all of the input methods available to your user when the reader begins waiting for input. Used by MobileReaderDelegate.onRequestReaderInput.
- RefundStatus
- SetupAttemptStatus
- Statuses for a SetupAttempt
- SetupIntentStatus
- SetupIntentUsage
- The SetupIntent usage options tell Stripe how the payment method is intended to be used in the future. Stripe will use the chosen option to pick the most frictionless flow for the customer.
- SimulatedCardType
- Enum used to simulate various types of cards and error cases.
- SimulateReaderUpdate
- Enum used to simulate various types of reader updates being available for a simulated bluetooth or local mobile reader.
- TerminalExceptionCode
- Android exception codes: https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.models/-terminal-exception/-terminal-error-code/index.html IOS exception codes: https://stripe.dev/stripe-terminal-ios/docs/Enums/SCPError.html
- UpdateComponent
- UpdateTimeEstimate
Mixins
- ReaderDelegate
- The ReaderDelegate mixin is a common abstraction across the different listener interfaces. It should exist for the entire duration of your connection to a reader. It will receive events related to the status of the reader.
- ReaderDisconnectDelegate
- ReaderPortableDelegate
- ReaderReconnectionDelegate
- The ReaderReconnectionDelegate mixin is implemented in order to receive updates from auto reconnection.
Typedefs
-
Cancellable
= Future<
void> Function()