Checkout

Field note

What it does

JavaScript API reference Use our API reference to navigate the Stripe Terminal JavaScript SDK. Ask about this page Copy for LLM View as Markdown Install tools API methods StripeTerminal.create() discoverReaders() connectReader() disconnectReader() getConnectionStatus() getPaymentStatus() clearCachedCredentials() collectPaymentMethod() cancelCollectPaymentMethod() processPayment() cancelProcessPayment() collectSetupIntentPaymentMethod() cancelCollectSetupIntentPaymentMethod() confirmSetupIntent() cancelConfirmSetupIntent() readReusableCard() cancelReadReusableCard() setReaderDisplay() clearReaderDisplay() setSimulatorConfiguration() getSimulatorConfiguration() collectRefundPaymentMethod() cancelCollectRefundPaymentMethod() processRefund() cancelProcessRefund() collectInputs() cancelCollectInputs() print() StripeTerminal.create([options]) Creates an instance of StripeTerminal with the given options: Option Description onFetchConnectionToken An event handler that fetches a connection token from your backend. onUnexpectedReaderDisconnect An event handler called when a reader disconnects from your app. onConnectionStatusChange optional An event handler called when the SDK’s ConnectionStatus changes. onPaymentStatusChange optional An event handler called when the SDK’s PaymentStatus changes. readerBehavior optional An object that sets the behavior on the reader throughout the lifecycle of the SDK. See below for readerBehavior configuration options. Reader behavior configuration Today, there is only one behavior configuration option: Behavior Description allowCustomerCancel A Boolean that determines whether the customer can cancel collectPaymentMethod from the reader’s interface.

Capabilities

Available capabilities

Tags

Tags

Ways to use it

Ways to use it