Terminal

@Singleton
class Terminal

The Terminal is the top-level object for the Stripe Terminal SDK.

Use of this SDK is subject to the Stripe Terminal Terms: https://stripe.com/terminal/legal

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Get the currently connected Reader if there is one.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
Link copied to clipboard

Cancel an existing SetupIntent.

Link copied to clipboard

Clears the current connection token, saved reader sessions, and any other cached credentials. You can use this method to switch accounts in your app, e.g. to switch between live and test Stripe API keys on your backend.

Link copied to clipboard

Clears the reader display and resets it to the splash screen

Link copied to clipboard

Display forms and collect information from customers. Available for BBPOS WisePOS E and Stripe S700.

Link copied to clipboard
fun collectPaymentMethod(intent: PaymentIntent, config: CollectConfiguration = CollectConfiguration.Builder().build(), callback: PaymentIntentCallback): Cancelable

Collects a payment method for the given PaymentIntent.

Link copied to clipboard
fun collectRefundPaymentMethod(refundParams: RefundParameters, config: RefundConfiguration = RefundConfiguration.Builder().build(), callback: Callback): Cancelable

Initiates an in-person refund with a given set of RefundParameters by collecting the payment method that is to be refunded.

Link copied to clipboard
fun collectSetupIntentPaymentMethod(intent: SetupIntent, allowRedisplay: AllowRedisplay, config: SetupIntentConfiguration = SetupIntentConfiguration.Builder().build(), callback: SetupIntentCallback): Cancelable

Collects a payment method for a SetupIntent.

Link copied to clipboard

Confirms a payment after collecting a payment method succeeds.

Link copied to clipboard

Confirms an in-person refund after the refund payment method has been collected.

Link copied to clipboard

Confirm that your customer intends to set up the current or provided payment method.

Link copied to clipboard
fun connectReader(reader: Reader, config: ConnectionConfiguration, connectionCallback: ReaderCallback)
Link copied to clipboard

Creates a new PaymentIntent with the given parameters.

Link copied to clipboard

Create a new SetupIntent with the given parameters.

Link copied to clipboard
fun disconnectReader(callback: Callback)

Attempts to disconnect from the currently connected reader.

Link copied to clipboard
Link copied to clipboard

Retrieves current settings from the connected reader.

Link copied to clipboard
fun retrievePaymentIntent(clientSecret: String, callback: PaymentIntentCallback)

Retrieves a PaymentIntent with a client secret.

Link copied to clipboard
fun retrieveSetupIntent(clientSecret: String, callback: SetupIntentCallback)

Retrieves a SetupIntent with a client secret.

Link copied to clipboard
fun setReaderDisplay(cart: Cart, callback: Callback)

Updates the reader display with transaction information. This method is for display purposes only and has no correlation with what the customer is actually charged. Tax and total are also not automatically calculated and must be set in Cart.

Link copied to clipboard

Changes settings on the connected reader.