toggle menu
Stripe Terminal Android SDK (v4.7.1)
switch theme
core
com.
stripe.
stripeterminal
Terminal
Companion
Terminal
Application
Delegate
taptopay
com.
stripe.
stripeterminal.
taptopay
Tap
To
Pay
Companion
external
com.
stripe.
stripeterminal.
external
Collect
Data
Connection
Token
Provider
For
Handoff
Mode
External
Channel
Internal
Api
Offline
Mode
Print
Api
Surcharging
com.
stripe.
stripeterminal.
external.
api
Api
Error
Api
Error
Type
API_CONNECTION_ERROR
API_ERROR
AUTHENTICATION_ERROR
CARD_ERROR
IDEMPOTENCY_ERROR
INVALID_REQUEST_ERROR
RATE_LIMIT_ERROR
com.
stripe.
stripeterminal.
external.
callable
Callback
Cancelable
Collected
Data
Callback
Collect
Inputs
Result
Callback
Connection
Token
Callback
Connection
Token
Provider
Discovery
Listener
Error
Callback
Handoff
Reader
Listener
Internet
Reader
Listener
Location
List
Callback
Mobile
Reader
Listener
Offline
Listener
Payment
Intent
Callback
Payment
Method
Callback
Reader
Callback
Reader
Disconnect
Listener
Reader
Listenable
Reader
Reconnection
Listener
Reader
Settings
Callback
Reader
Software
Update
Callback
Refund
Callback
Setup
Intent
Callback
Tap
To
Pay
Reader
Listener
Terminal
Listener
com.
stripe.
stripeterminal.
external.
json
Api
Error
Json
Adapter
Api
Error
Serializer
Device
Type
Serializer
Expandable
Location
Serializer
Payment
Method
Types
Serializer
Payment
Method
Union
Adapter
Payment
Method
Union
Serializer
Reader
Serializer
Setup
Attempt
Union
Json
Adapter
Setup
Attempt
Union
Serializer
com.
stripe.
stripeterminal.
external.
models
Address
Affirm
Details
Allow
Redisplay
ALWAYS
LIMITED
UNSPECIFIED
Amount
Details
Battery
Status
UNKNOWN
CRITICAL
LOW
NOMINAL
Bluetooth
Device
Capture
Method
Companion
Card
Details
Card
Networks
Card
Options
Card
Present
Capture
Method
Companion
Card
Present
Details
Card
Present
Options
Card
Present
Parameters
Builder
Card
Present
Request
Partial
Authorization
IF_AVAILABLE
NEVER
Card
Present
Routing
Option
Parameters
Card
Present
Routing
Options
Cart
Builder
Cart
Line
Item
Builder
Charge
Collect
Configuration
Builder
Collect
Data
Configuration
Builder
Collect
Data
Type
MAGSTRIPE
NFC_UID
Collected
Data
Collect
Inputs
Parameters
Collect
Inputs
Result
Confirm
Configuration
Builder
Connection
Configuration
Bluetooth
Connection
Configuration
External
Usb
Channel
Configuration
Handoff
Connection
Configuration
Internet
Connection
Configuration
Tap
To
Pay
Connection
Configuration
Usb
Connection
Configuration
Connection
Status
NOT_CONNECTED
DISCOVERING
CONNECTING
CONNECTED
Connection
Token
Exception
Create
Configuration
Customer
Acceptance
Parameters
Builder
Customer
Acceptance
Type
ONLINE
OFFLINE
Device
Type
CHIPPER_1X
CHIPPER_2X
STRIPE_M2
TAP_TO_PAY_DEVICE
VERIFONE_P400
WISECUBE
WISEPAD_3
WISEPAD_3S
WISEPOS_E
WISEPOS_E_DEVKIT
ETNA
STRIPE_S700
STRIPE_S700_DEVKIT
STRIPE_S710
STRIPE_S710_DEVKIT
STRIPE_T600
STRIPE_T600_DEVKIT
STRIPE_T610
STRIPE_T610_DEVKIT
VERIFONE_V660P
VERIFONE_V660P_DEVKIT
VERIFONE_M425
VERIFONE_M450
VERIFONE_P630
VERIFONE_UX700
VERIFONE_UX700_DEVKIT
UNKNOWN
Disconnect
Reason
UNKNOWN
DISCONNECT_REQUESTED
REBOOT_REQUESTED
SECURITY_REBOOT
CRITICALLY_LOW_BATTERY
POWERED_OFF
BLUETOOTH_DISABLED
USB_DISCONNECTED
IDLE_POWER_DOWN
BLUETOOTH_PEER_REMOVED_PAIRING_INFORMATION
Discovery
Configuration
Bluetooth
Discovery
Configuration
Handoff
Discovery
Configuration
Internet
Discovery
Configuration
Tap
To
Pay
Discovery
Configuration
Usb
Discovery
Configuration
Dynamic
Currency
Conversion
Dynamic
Currency
Conversion
Options
Email
Input
Builder
Email
Result
Expandable
Location
Expanded
Reference
External
Usb
Channel
Data
Completion
Callback
Disconnect
Reason
REQUESTED
READER_DISCONNECTED
STAND_DISCONNECTED
READER_RESET
READ_ERROR
WRITE_ERROR
Error
Completion
Callback
External
Usb
Channel
Listener
Generated
From
Incremental
Authorization
Status
UNKNOWN
NOT_SUPPORTED
SUPPORTED
Input
List
Locations
Parameters
Builder
Companion
Location
Location
Status
UNKNOWN
SET
NOT_SET
Mandate
Online
Acceptance
Data
Mandate
Parameters
Moto
Configuration
Network
Status
UNKNOWN
OFFLINE
ONLINE
Next
Action
Companion
Numeric
Input
Builder
Numeric
Result
Offline
Behavior
REQUIRE_ONLINE
PREFER_ONLINE
FORCE_OFFLINE
Offline
Card
Present
Details
Companion
Offline
Details
Companion
Offline
Status
Offline
Status
Details
Payment
Intent
Payment
Intent
Parameters
Builder
Payment
Intent
Status
CANCELED
PROCESSING
REQUIRES_CAPTURE
REQUIRES_CONFIRMATION
REQUIRES_PAYMENT_METHOD
REQUIRES_ACTION
SUCCEEDED
Payment
Method
Payment
Method
Details
Payment
Method
Options
Payment
Method
Options
Parameters
Builder
Payment
Method
Type
Companion
CARD_PRESENT
CARD
INTERAC_PRESENT
WECHAT_PAY
AFFIRM
PAYNOW
PAYPAY
Payment
Method
Union
Expanded
Reference
Payment
Status
NOT_READY
READY
WAITING_FOR_INPUT
PROCESSING
Paynow
Details
Paypay
Details
Phone
Input
Builder
Phone
Result
Print
Content
Bitmap
Companion
Reader
Companion
Network
Status
ONLINE
OFFLINE
UNKNOWN
Reader
Accessibility
Accessibility
Error
Reader
Battery
Info
Companion
Reader
Connection
Bluetooth
Usb
Reader
Display
Message
CHECK_MOBILE_DEVICE
RETRY_CARD
INSERT_CARD
INSERT_OR_SWIPE_CARD
SWIPE_CARD
REMOVE_CARD
MULTIPLE_CONTACTLESS_CARDS_DETECTED
TRY_ANOTHER_READ_METHOD
TRY_ANOTHER_CARD
CARD_REMOVED_TOO_EARLY
Reader
Event
CARD_INSERTED
CARD_REMOVED
Reader
Input
Options
Reader
Input
Option
NONE
INSERT
SWIPE
TAP
MANUAL_ENTRY
Reader
Settings
Reader
Settings
Parameters
Accessibility
Parameters
Reader
Software
Update
Update
Component
INCREMENTAL
FIRMWARE
CONFIG
KEYS
Update
Duration
Estimate
LESS_THAN_ONE_MINUTE
ONE_TO_TWO_MINUTES
TWO_TO_FIVE_MINUTES
FIVE_TO_FIFTEEN_MINUTES
Reader
Support
Result
Not
Supported
Supported
Reader
Text
To
Speech
Status
OFF
HEADPHONES
SPEAKERS
Read
Reusable
Card
Parameters
Builder
Companion
Receipt
Details
Companion
Redirect
Url
Refund
Refund
Configuration
Builder
Refund
Parameters
Builder
Id
Charge
Payment
Intent
Request3d
Secure
Type
AUTOMATIC
ANY
Routing
Priority
DOMESTIC
INTERNATIONAL
Selection
Button
Selection
Button
Style
PRIMARY
SECONDARY
Selection
Input
Builder
Selection
Result
Setup
Attempt
Setup
Attempt
Status
REQUIRES_CONFIRMATION
REQUIRES_ACTION
PROCESSING
SUCCEEDED
FAILED
ABANDONED
Setup
Attempt
Union
Expanded
Reference
Setup
Error
Setup
Error
Type
API_CONNECTION_ERROR
API_ERROR
AUTHENTICATION_ERROR
CARD_ERROR
IDEMPOTENCY_ERROR
INVALID_REQUEST_ERROR
RATE_LIMIT_ERROR
Setup
Intent
Setup
Intent
Cancellation
Parameters
Builder
Companion
Setup
Intent
Cancellation
Reason
DUPLICATE
REQUESTED_BY_CUSTOMER
ABANDONED
Setup
Intent
Card
Present
Details
Setup
Intent
Configuration
Builder
Setup
Intent
Next
Action
Setup
Intent
Offline
Details
Companion
Setup
Intent
Parameters
Builder
Companion
Setup
Intent
Payment
Method
Details
Setup
Intent
Status
REQUIRES_PAYMENT_METHOD
REQUIRES_CONFIRMATION
REQUIRES_ACTION
PROCESSING
SUCCEEDED
CANCELLED
Setup
Intent
Usage
ON_SESSION
OFF_SESSION
Signature
Input
Builder
Signature
Result
Simulated
Card
Simulated
Card
Type
VISA
VISA_DEBIT
MASTERCARD
MASTERCARD_DEBIT
MASTERCARD_PREPAID
AMEX
AMEX_2
DISCOVER
DISCOVER_2
DINERS
DINERS_14_DIGITS
JCB
UNION_PAY
INTERAC
EFTPOS_AU_DEBIT
VISA_US_COMMON_DEBIT
CHARGE_DECLINED
CHARGE_DECLINED_INSUFFICIENT_FUNDS
CHARGE_DECLINED_LOST_CARD
CHARGE_DECLINED_STOLEN_CARD
CHARGE_DECLINED_EXPIRED_CARD
CHARGE_DECLINED_PROCESSING_ERROR
EFTPOS_AU_VISA_DEBIT
EFTPOS_AU_DEBIT_MASTERCARD
OFFLINE_PIN_CVM
OFFLINE_PIN_SCA_RETRY
ONLINE_PIN_CVM
ONLINE_PIN_SCA_RETRY
Simulated
Collect
Inputs
Result
Simulated
Collect
Inputs
Result
Succeeded
Simulated
Collect
Inputs
Result
Timeout
Simulated
Collect
Inputs
Skip
Behavior
NONE
ALL
Simulate
Reader
Update
UPDATE_AVAILABLE
NONE
REQUIRED
REQUIRED_FOR_OFFLINE
LOW_BATTERY
LOW_BATTERY_SUCCEED_CONNECT
RANDOM
Simulator
Configuration
Companion
Single
Use
Mandate
Surcharge
Surcharge
Configuration
Builder
Surcharge
Consent
Builder
Surcharge
Consent
Collection
DISABLED
ENABLED
Surcharge
Details
Tap
To
Pay
Ux
Configuration
Builder
Color
Default
Resource
Value
Color
Scheme
Builder
Dark
Mode
SYSTEM
DARK
LIGHT
Tap
Zone
Default
Manual
Builder
Tap
Zone
Indicator
DEFAULT
ABOVE
BELOW
FRONT
BEHIND
Tap
Zone
Position
Default
Manual
Terminal
Error
Code
Companion
CANCEL_FAILED
NOT_CONNECTED_TO_READER
ALREADY_CONNECTED_TO_READER
BLUETOOTH_PERMISSION_DENIED
CONFIRM_INVALID_PAYMENT_INTENT
CONFIRM_INVALID_SETUP_INTENT
INVALID_CLIENT_SECRET
UNSUPPORTED_OPERATION
UNEXPECTED_OPERATION
UNSUPPORTED_SDK
USB_PERMISSION_DENIED
MISSING_PREREQUISITE
MISSING_REQUIRED_PARAMETER
INVALID_REQUIRED_PARAMETER
INVALID_TIP_PARAMETER
TAP_TO_PAY_LIBRARY_NOT_INCLUDED
TAP_TO_PAY_UNSUPPORTED_DEVICE
TAP_TO_PAY_UNSUPPORTED_ANDROID_VERSION
TAP_TO_PAY_DEVICE_TAMPERED
TAP_TO_PAY_INSECURE_ENVIRONMENT
TAP_TO_PAY_DEBUG_NOT_SUPPORTED
TAP_TO_PAY_UNSUPPORTED_PROCESSOR
OFFLINE_MODE_UNSUPPORTED_ANDROID_VERSION
CANCELED
LOCATION_SERVICES_DISABLED
BLUETOOTH_SCAN_TIMED_OUT
BLUETOOTH_LOW_ENERGY_UNSUPPORTED
READER_SOFTWARE_UPDATE_FAILED_BATTERY_LOW
READER_SOFTWARE_UPDATE_FAILED_INTERRUPTED
CARD_INSERT_NOT_READ
CARD_SWIPE_NOT_READ
CARD_READ_TIMED_OUT
CARD_REMOVED
CUSTOMER_CONSENT_REQUIRED
CARD_LEFT_IN_READER
USB_DISCOVERY_TIMED_OUT
FEATURE_NOT_ENABLED_ON_ACCOUNT
READER_BUSY
READER_COMMUNICATION_ERROR
READER_TAMPERED
BLUETOOTH_ERROR
BLUETOOTH_DISCONNECTED
BLUETOOTH_RECONNECT_STARTED
USB_DISCONNECTED
USB_RECONNECT_STARTED
READER_CONNECTED_TO_ANOTHER_DEVICE
READER_BATTERY_CRITICALLY_LOW
READER_SOFTWARE_UPDATE_FAILED
READER_SOFTWARE_UPDATE_FAILED_READER_ERROR
READER_SOFTWARE_UPDATE_FAILED_SERVER_ERROR
TAP_TO_PAY_NFC_DISABLED
UNSUPPORTED_READER_VERSION
GENERIC_READER_ERROR
UNEXPECTED_SDK_ERROR
DECLINED_BY_STRIPE_API
DECLINED_BY_READER
REQUEST_TIMED_OUT
STRIPE_API_CONNECTION_ERROR
STRIPE_API_ERROR
STRIPE_API_RESPONSE_DECODING_ERROR
CONNECTION_TOKEN_PROVIDER_ERROR
SESSION_EXPIRED
ANDROID_API_LEVEL_ERROR
AMOUNT_EXCEEDS_MAX_OFFLINE_AMOUNT
OFFLINE_PAYMENTS_DATABASE_TOO_LARGE
READER_CONNECTION_NOT_AVAILABLE_OFFLINE
LOCATION_CONNECTION_NOT_AVAILABLE_OFFLINE
NO_LAST_SEEN_ACCOUNT
INVALID_OFFLINE_CURRENCY
CARD_SWIPE_NOT_AVAILABLE
INTERAC_NOT_SUPPORTED_OFFLINE
ONLINE_PIN_NOT_SUPPORTED_OFFLINE
MOBILE_WALLET_NOT_SUPPORTED_ON_SETUP_INTENTS
OFFLINE_AND_CARD_EXPIRED
OFFLINE_TRANSACTION_DECLINED
OFFLINE_COLLECT_AND_CONFIRM_MISMATCH
OFFLINE_TESTMODE_PAYMENT_IN_LIVEMODE
OFFLINE_LIVEMODE_PAYMENT_IN_TESTMODE
OFFLINE_PAYMENT_INTENT_NOT_FOUND
MISSING_EMV_DATA
CONNECTION_TOKEN_PROVIDER_ERROR_WHILE_FORWARDING
ACCOUNT_ID_MISMATCH_WHILE_FORWARDING
FORCE_OFFLINE_WITH_FEATURE_DISABLED
NOT_CONNECTED_TO_INTERNET_AND_REQUIRE_ONLINE_SET
TEST_CARD_IN_LIVEMODE
COLLECT_INPUTS_APPLICATION_ERROR
COLLECT_INPUTS_TIMED_OUT
COLLECT_INPUTS_INVALID_PARAMETER
COLLECT_INPUTS_UNSUPPORTED
READER_SETTINGS_ERROR
READER_MISSING_ENCRYPTION_KEYS
INVALID_SURCHARGE_PARAMETER
READER_COMMUNICATION_SSL_ERROR
ALLOW_REDISPLAY_INVALID
CANCELED_DUE_TO_INTEGRATION_ERROR
PRINTER_BUSY
PRINTER_PAPERJAM
PRINTER_OUT_OF_PAPER
PRINTER_COVER_OPEN
PRINTER_ABSENT
PRINTER_UNAVAILABLE
PRINTER_ERROR
INVALID_MOTO_CONFIGURATION
Terminal
Exception
Text
Input
Builder
Text
Result
Tip
Tipping
Configuration
Builder
Toggle
Toggle
Result
ENABLED
DISABLED
SKIPPED
Toggle
Value
ENABLED
DISABLED
Usb
Device
Use
Stripe
Sdk
Companion
Wallet
Wechat
Pay
Details
Wechat
Pay
Display
Qr
Code
com.
stripe.
stripeterminal.
log
Log
Level
NONE
ERROR
WARNING
INFO
VERBOSE
handoffclient
com.
stripe.
stripeterminal.
handoffclient
Handoff
Connection
Token
Provider
com.
stripe.
stripeterminal.
handoffclient.
appsondevices
Apps
On
Devices
Companion
com.
stripe.
stripeterminal.
handoffclient.
appsondevices.
controller
Apps
On
Devices
Controller
Apps
On
Devices
Updater
Controller
com.
stripe.
stripeterminal.
handoffclient.
appsondevices.
extensions
get
Device
Details()
get
Night
Mode
Enabled()
lock
Screen()
set
Night
Mode
Enabled()
com.
stripe.
stripeterminal.
handoffclient.
appsondevices.
models
Device
Details
com.
stripe.
stripeterminal.
handoffclient.
appsondevices.
models.
callable
Apps
On
Devices
Result
Callback
external
/
com.stripe.stripeterminal.external.models
/
Reader
/
pinKeyProfileId
pin
Key
Profile
Id
@
Transient
val
pinKeyProfileId
:
String
?
=
null